LibBoard::Shape Struct Reference

#include <Shapes.h>

Inheritance diagram for LibBoard::Shape:

Public Types
enum	LineCap { ButtCap = 0, RoundCap, SquareCap }
enum	LineJoin { MiterJoin = 0, RoundJoin, BevelJoin }
enum	LineStyle {   SolidStyle = 0, DashStyle, DotStyle, DashDotStyle,   DashDotDotStyle, DashDotDotDotStyle }

Public Member Functions
	Shape (DGtal::Color penColor, DGtal::Color fillColor, double lineWidth, LineStyle style, const LineCap cap, const LineJoin join, int depth)
virtual	~Shape ()
virtual const std::string &	name () const
virtual Shape *	clone () const =0
bool	filled () const
virtual Point	center () const =0
virtual Shape &	rotate (double angle, const Point &center)=0
virtual Shape &	rotate (double angle)=0
Shape &	rotateDeg (double angle, const Point &center)
Shape &	rotateDeg (double angle)
virtual Shape &	translate (double dx, double dy)=0
virtual Shape &	scale (double sx, double sy)=0
virtual Shape &	scale (double s)=0
virtual Rect	boundingBox () const =0
Rect	bbox ()
Shape &	operator-- ()
Shape &	operator++ ()
virtual void	scaleAll (double s)=0
virtual void	flushPostscript (std::ostream &stream, const TransformEPS &transform) const =0
virtual void	flushFIG (std::ostream &stream, const TransformFIG &transform, std::map< DGtal::Color, int > &colormap) const =0
virtual void	flushSVG (std::ostream &stream, const TransformSVG &transform) const =0
virtual void	flushTikZ (std::ostream &stream, const TransformTikZ &transform) const =0
int	depth () const
virtual void	depth (int)
virtual void	shiftDepth (int shift)
const DGtal::Color &	penColor () const
const DGtal::Color &	fillColor () const

Protected Member Functions
std::string	svgProperties (const TransformSVG &transform) const
std::string	postscriptProperties () const
std::string	tikzProperties (const TransformTikZ &transform) const

Protected Attributes
int	_depth
DGtal::Color	_penColor
DGtal::Color	_fillColor
double	_lineWidth
LineStyle	_lineStyle
LineCap	_lineCap
LineJoin	_lineJoin

Static Private Attributes
static const std::string	_name

---

Detailed Description

Abstract structure for a 2D shape.

Shape structure.

---

Member Enumeration Documentation

enum LibBoard::Shape::LineCap

Enumerator:

ButtCap
RoundCap
SquareCap

enum LibBoard::Shape::LineJoin

Enumerator:

MiterJoin
RoundJoin
BevelJoin

enum LibBoard::Shape::LineStyle

Enumerator:

SolidStyle
DashStyle
DotStyle
DashDotStyle
DashDotDotStyle
DashDotDotDotStyle

---

Constructor & Destructor Documentation

LibBoard::Shape::Shape ( DGtal::Color  penColor, DGtal::Color  fillColor, double  lineWidth, LineStyle  style, const LineCap  cap, const LineJoin  join, int  depth  )

inline

Shape constructor.

Parameters:

penColor	The pen color of the shape.
fillColor	The fill color of the shape.
lineWidth	The line thickness.
depth	The depth of the shape.

virtual LibBoard::Shape::~Shape ( )

inlinevirtual

Shape destructor.

---

Member Function Documentation

Rect LibBoard::Shape::bbox ( )

inline

Returns the bounding box of the figure. (Convenience method to call "boundingBox" with a short name.)

References boundingBox().

virtual Rect LibBoard::Shape::boundingBox ( ) const

pure virtual

Returns the bounding box of the figure.

Returns:

The rectangle of the bounding box.

Implemented in LibBoard::Text, LibBoard::Ellipse, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

Referenced by bbox().

virtual Point LibBoard::Shape::center ( ) const

pure virtual

Returns the gravity center of the shape.

Returns:

The center of the shape.

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, and LibBoard::ShapeList.

Referenced by rotateDeg().

virtual Shape* LibBoard::Shape::clone ( ) const

pure virtual

Return a copy of the shape.

Returns:

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Triangle, LibBoard::Image, LibBoard::Rectangle, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

Referenced by LibBoard::Board::addDuplicates(), LibBoard::ShapeList::addShape(), LibBoard::ShapeList::operator+=(), and LibBoard::ShapeList::operator<<().

int LibBoard::Shape::depth ( ) const

inline

References _depth.

Referenced by LibBoard::ShapeList::addShape(), LibBoard::ShapeList::operator<<(), LibBoard::Board::saveFIG(), and LibBoard::shapeGreaterDepth().

void LibBoard::Shape::depth ( int  d )

virtual

References _depth.

const DGtal::Color & LibBoard::Shape::fillColor ( ) const

inline

References _fillColor.

bool LibBoard::Shape::filled ( ) const

inline

Checks whether a shape is filled with a color or not.

Returns:

true if the shape is filled.

References _fillColor.

Referenced by LibBoard::Arrow::flushFIG(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), LibBoard::Ellipse::flushFIG(), LibBoard::Arrow::flushPostscript(), LibBoard::Polyline::flushPostscript(), LibBoard::Ellipse::flushPostscript(), and LibBoard::Arc::flushPostscript().

virtual void LibBoard::Shape::flushFIG ( std::ostream &  stream, const TransformFIG &  transform, std::map< DGtal::Color, int > &  colormap  ) const

pure virtual

Writes the FIG code of the shape in a stream according to a transform.

Parameters:

stream	The output stream.
transform	A 2D transform to be applied.

Implemented in LibBoard::Text, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Image, LibBoard::Rectangle, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

virtual void LibBoard::Shape::flushPostscript ( std::ostream &  stream, const TransformEPS &  transform  ) const

pure virtual

Writes the EPS code of the shape in a stream according to a transform.

Parameters:

stream	The output stream.
transform	A 2D transform to be applied.

Implemented in LibBoard::Text, LibBoard::Arc, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

virtual void LibBoard::Shape::flushSVG ( std::ostream &  stream, const TransformSVG &  transform  ) const

pure virtual

Writes the SVG code of the shape in a stream according to a transform.

Parameters:

stream	The output stream.
transform	A 2D transform to be applied.

Implemented in LibBoard::Text, LibBoard::Arc, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Image, LibBoard::Rectangle, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

virtual void LibBoard::Shape::flushTikZ ( std::ostream &  stream, const TransformTikZ &  transform  ) const

pure virtual

Writes the TikZ code of the shape in a stream according to a transform.

Parameters:

stream	The output stream.
transform	A 2D transform to be applied.

Implemented in LibBoard::Text, LibBoard::Arc, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Image, LibBoard::Rectangle, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

const std::string & LibBoard::Shape::name ( ) const

virtual

Returns the generic name of the shape (e.g., Circle, Rectangle, etc.)

Returns:

Reimplemented in LibBoard::Text, LibBoard::Arc, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Triangle, LibBoard::Image, LibBoard::Rectangle, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

References _name.

Shape & LibBoard::Shape::operator++ ( )

inline

Increment the depth of the shape. (Push the shape toward the background.)

Returns:

References _depth.

Shape & LibBoard::Shape::operator-- ( )

inline

Decrement the depth of the shape. (Pull the shape toward the foreground.)

Returns:

References _depth.

const DGtal::Color & LibBoard::Shape::penColor ( ) const

inline

References _penColor.

std::string LibBoard::Shape::postscriptProperties ( ) const

protected

Return a string of the properties lineWidth, penColor, lineCap, and lineJoin as Postscript commands.

Returns:

A string of the Postscript commands.

References _lineCap, _lineJoin, _lineStyle, and _lineWidth.

Referenced by LibBoard::Dot::flushPostscript(), LibBoard::Line::flushPostscript(), LibBoard::Arrow::flushPostscript(), LibBoard::Polyline::flushPostscript(), and LibBoard::Ellipse::flushPostscript().

virtual Shape& LibBoard::Shape::rotate ( double  angle, const Point &  center  )

pure virtual

Rotate the shape around a given center of rotation.

Parameters:

angle	The rotation angle in radian.
center	The center of rotation.

Returns:

A reference to the shape itself.

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, LibBoard::Group, LibBoard::Board, and LibBoard::ShapeList.

Referenced by LibBoard::Board::addDuplicates(), and rotateDeg().

virtual Shape& LibBoard::Shape::rotate ( double  angle )

pure virtual

Rotate the shape around its center.

Parameters:

angle

The rotation angle in radian.

Returns:

A reference to the shape itself.

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, LibBoard::Group, LibBoard::Board, and LibBoard::ShapeList.

Shape & LibBoard::Shape::rotateDeg ( double  angle, const Point &  center  )

inline

Rotate the shape around a given center of rotation.

Parameters:

angle	The rotation angle in degree.
center	The center of rotation.

Returns:

A reference to the shape itself.

References M_PI, and rotate().

Shape & LibBoard::Shape::rotateDeg ( double  angle )

inline

Rotate the shape around its center.

Parameters:

angle	The rotation angle in degree.
center	The center of rotation.

Returns:

A reference to the shape itself.

References center(), M_PI, and rotate().

virtual Shape& LibBoard::Shape::scale ( double  sx, double  sy  )

pure virtual

Scale the shape along the x an y axis.

Parameters:

sx	The scale factor along the x axis.
sy	The scale factor along the y axis.

Returns:

The shape itself.

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, LibBoard::Group, LibBoard::Board, and LibBoard::ShapeList.

Referenced by LibBoard::Board::addDuplicates().

virtual Shape& LibBoard::Shape::scale ( double  s )

pure virtual

Scale the shape along both axis.

Parameters:

s	The scale factor along both axis.

Returns:

The shape itself.

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, LibBoard::Group, LibBoard::Board, and LibBoard::ShapeList.

virtual void LibBoard::Shape::scaleAll ( double  s )

pure virtual

Scales all the values (positions, dimensions, etc.) associated with the shape.

Parameters:

s	The scaling factor.

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Rectangle, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, and LibBoard::ShapeList.

Referenced by LibBoard::ShapeList::addShape(), and LibBoard::Board::State::unit().

void LibBoard::Shape::shiftDepth ( int  shift )

virtual

Reimplemented in LibBoard::ShapeList.

References _depth.

std::string LibBoard::Shape::svgProperties ( const TransformSVG &  transform ) const

protected

Return a string of the svg properties lineWidth, opacity, penColor, fillColor, lineCap, and lineJoin.

Returns:

A string of the properties suitable for inclusion in an svg tag.

References _fillColor, _lineCap, _lineJoin, _lineStyle, _lineWidth, _penColor, LibBoard::TransformSVG::mapWidth(), and SolidStyle.

Referenced by LibBoard::Dot::flushSVG(), LibBoard::Line::flushSVG(), LibBoard::Polyline::flushSVG(), LibBoard::Rectangle::flushSVG(), LibBoard::Ellipse::flushSVG(), LibBoard::Circle::flushSVG(), and LibBoard::Arc::flushSVG().

std::string LibBoard::Shape::tikzProperties ( const TransformTikZ &  transform ) const

protected

Return a string of the properties lineWidth, penColor, lineCap, and lineJoin as TikZ commands.

Returns:

A string of the TikZ commands.

References _fillColor, _lineCap, _lineJoin, _lineStyle, _lineWidth, _penColor, and LibBoard::TransformSVG::mapWidth().

Referenced by LibBoard::Line::flushTikZ(), LibBoard::Arrow::flushTikZ(), LibBoard::Polyline::flushTikZ(), LibBoard::Rectangle::flushTikZ(), LibBoard::Ellipse::flushTikZ(), LibBoard::Circle::flushTikZ(), LibBoard::Arc::flushTikZ(), and LibBoard::Text::flushTikZ().

virtual Shape& LibBoard::Shape::translate ( double  dx, double  dy  )

pure virtual

Translate the shape by a given offset.

Parameters:

dx	The x offset.
dy	The y offset.

Returns:

A reference to the shape itself.

Implemented in LibBoard::Text, LibBoard::Circle, LibBoard::Ellipse, LibBoard::Polyline, LibBoard::Line, LibBoard::Dot, LibBoard::Group, LibBoard::Board, and LibBoard::ShapeList.

Referenced by LibBoard::Board::addDuplicates().

---

Field Documentation

int LibBoard::Shape::_depth

protected

The depth of the shape.

Referenced by depth(), LibBoard::Dot::flushFIG(), LibBoard::Line::flushFIG(), LibBoard::Arrow::flushFIG(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), LibBoard::Image::flushFIG(), LibBoard::Ellipse::flushFIG(), LibBoard::Text::flushFIG(), LibBoard::GouraudTriangle::flushPostscript(), LibBoard::GouraudTriangle::flushSVG(), operator++(), operator--(), and shiftDepth().

DGtal::Color LibBoard::Shape::_fillColor

protected

The color of the shape.

Referenced by fillColor(), filled(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), LibBoard::Ellipse::flushFIG(), LibBoard::Polyline::flushPostscript(), LibBoard::Ellipse::flushPostscript(), LibBoard::Arc::flushPostscript(), LibBoard::Arrow::flushSVG(), LibBoard::Text::flushSVG(), LibBoard::GouraudTriangle::GouraudTriangle(), svgProperties(), and tikzProperties().

LineCap LibBoard::Shape::_lineCap

protected

The linecap attribute. (The way line terminates.)

Referenced by LibBoard::Dot::flushFIG(), LibBoard::Line::flushFIG(), LibBoard::Arrow::flushFIG(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), postscriptProperties(), svgProperties(), and tikzProperties().

LineJoin LibBoard::Shape::_lineJoin

protected

The linejoin attribute. (The shape of line junctions.)

Referenced by LibBoard::Dot::flushFIG(), LibBoard::Line::flushFIG(), LibBoard::Arrow::flushFIG(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), postscriptProperties(), svgProperties(), and tikzProperties().

LineStyle LibBoard::Shape::_lineStyle

protected

The line style (solid, dashed, etc.).

Referenced by LibBoard::Line::flushFIG(), LibBoard::Arrow::flushFIG(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), LibBoard::Image::flushFIG(), LibBoard::Ellipse::flushFIG(), LibBoard::Arrow::flushSVG(), postscriptProperties(), svgProperties(), and tikzProperties().

double LibBoard::Shape::_lineWidth

protected

The line thickness.

Referenced by LibBoard::Dot::flushFIG(), LibBoard::Line::flushFIG(), LibBoard::Arrow::flushFIG(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), LibBoard::Image::flushFIG(), LibBoard::Ellipse::flushFIG(), LibBoard::Arrow::flushPostscript(), LibBoard::Arrow::flushSVG(), postscriptProperties(), svgProperties(), and tikzProperties().

const std::string LibBoard::Shape::_name

staticprivate

The generic name of the shape.

Reimplemented in LibBoard::Text, LibBoard::Arc, LibBoard::Circle, LibBoard::Ellipse, LibBoard::GouraudTriangle, LibBoard::Triangle, LibBoard::Image, LibBoard::Rectangle, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Line, LibBoard::Dot, LibBoard::Group, and LibBoard::ShapeList.

Referenced by name().

DGtal::Color LibBoard::Shape::_penColor

protected

The color of the shape.

Referenced by LibBoard::Dot::flushFIG(), LibBoard::Line::flushFIG(), LibBoard::Arrow::flushFIG(), LibBoard::Polyline::flushFIG(), LibBoard::Rectangle::flushFIG(), LibBoard::Image::flushFIG(), LibBoard::Ellipse::flushFIG(), LibBoard::Text::flushFIG(), LibBoard::Dot::flushPostscript(), LibBoard::Line::flushPostscript(), LibBoard::Arrow::flushPostscript(), LibBoard::Polyline::flushPostscript(), LibBoard::Ellipse::flushPostscript(), LibBoard::Arc::flushPostscript(), LibBoard::Text::flushPostscript(), LibBoard::Arrow::flushSVG(), LibBoard::Text::flushSVG(), penColor(), svgProperties(), and tikzProperties().

---

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

• Shapes.h
• Shapes.cpp