LibBoard::Shape Struct Reference

Abstract structure for a 2D shape. More...

#include <Shape.h>

Inheritance diagram for LibBoard::Shape:

Public Member Functions
	Shape ()
virtual	~Shape ()
virtual const std::string &	name () const
virtual Shape *	clone () const =0
virtual Point	center (LineWidthFlag lineWidthFlag=IgnoreLineWidth) const
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
Shape &	moveCenter (double x, double y, LineWidthFlag lineWidthFlag=IgnoreLineWidth)
Shape &	moveCenter (Point p, LineWidthFlag lineWidthFlag=IgnoreLineWidth)
virtual Shape &	scale (double sx, double sy)=0
virtual Shape &	scale (double s)=0
Shape &	resize (double width, double height, LineWidthFlag lineWidthFlag)
Shape &	scaleToWidth (double w, LineWidthFlag lineWidthFlag)
Shape &	scaleToHeight (double h, LineWidthFlag lineWidthFlag)
virtual Rect	boundingBox (LineWidthFlag) const =0
Rect	bbox (LineWidthFlag) const
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< 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
virtual void	accept (ShapeVisitor &visitor)
	Accepts a visitor object.
virtual void	accept (const ShapeVisitor &visitor)
	Accepts a visitor object.
virtual void	accept (ConstShapeVisitor &visitor) const
	Accepts a const-shape visitor object.
virtual void	accept (const ConstShapeVisitor &visitor) const
	Accepts a const-shape visitor object.
virtual Shape *	accept (CompositeShapeTransform &transform) const
	Accept a composite shape transform.
virtual Shape *	accept (const CompositeShapeTransform &transform) const
	Accept a constant composite shape transform.
	Shape (const Shape &other)

Detailed Description

Abstract structure for a 2D shape.

Shape structure.

Examples

examples/rough.cpp, and examples/traversal.cpp.

Constructor & Destructor Documentation

Shape() [1/2]

LibBoard::Shape::Shape ( )

inline

Shape constructor.

~Shape()

LibBoard::Shape::~Shape ( )

virtual

Shape destructor.

Shape() [2/2]

LibBoard::Shape::Shape

(

const Shape &

other

)

Member Function Documentation

accept() [1/6]

Shape * LibBoard::Shape::accept ( CompositeShapeTransform &  transform ) const

virtual

Accept a composite shape transform.

Parameters

transform

A composite shape transform object.

Reimplemented in LibBoard::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::ShapeList, and LibBoard::Text.

References LibBoard::CompositeShapeTransform::map().

accept() [2/6]

Shape * LibBoard::Shape::accept ( const CompositeShapeTransform &  transform ) const

virtual

Accept a constant composite shape transform.

Parameters

transform

A constant composite shape transform object..

Reimplemented in LibBoard::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::ShapeList, and LibBoard::Text.

References LibBoard::CompositeShapeTransform::map().

accept() [3/6]

void LibBoard::Shape::accept ( const ConstShapeVisitor &  visitor ) const

virtual

Accepts a const-shape visitor object.

Parameters

visitor

A const-shape visitor object.

Reimplemented in LibBoard::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::ShapeList, and LibBoard::Text.

References LibBoard::ConstShapeVisitor::visit().

accept() [4/6]

void LibBoard::Shape::accept ( const ShapeVisitor &  visitor )

virtual

Accepts a visitor object.

Parameters

visitor

A visitor object.

Reimplemented in LibBoard::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::ShapeList, and LibBoard::Text.

References LibBoard::ShapeVisitor::visit().

accept() [5/6]

void LibBoard::Shape::accept ( ConstShapeVisitor &  visitor ) const

virtual

Accepts a const-shape visitor object.

Parameters

visitor

A const-shape visitor object.

Reimplemented in LibBoard::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::ShapeList, and LibBoard::Text.

References LibBoard::ConstShapeVisitor::visit().

accept() [6/6]

void LibBoard::Shape::accept ( ShapeVisitor &  visitor )

virtual

Accepts a visitor object.

Parameters

visitor

A visitor object.

Reimplemented in LibBoard::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::ShapeList, and LibBoard::Text.

References LibBoard::ShapeVisitor::visit().

Referenced by LibBoard::Group::accept(), LibBoard::Group::accept(), LibBoard::ShapeList::accept(), LibBoard::ShapeList::accept(), and LibBoard::makeRough().

bbox()

Rect LibBoard::Shape::bbox ( LineWidthFlag  flag ) const

inline

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

Examples

examples/Huffman.cpp, and examples/circled_framed.cpp.

References boundingBox().

Referenced by LibBoard::Board::drawBoundingBox(), LibBoard::Group::flushFIG(), LibBoard::Image::flushFIG(), LibBoard::framed(), main(), merge(), resize(), LibBoard::Board::saveEPS(), LibBoard::Board::saveFIG(), and LibBoard::Board::saveSVG().

boundingBox()

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

pure virtual

Compute the bounding box of the figure.

Returns

The rectangle of the bounding box.

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

Referenced by LibBoard::ShapeList::append(), bbox(), center(), LibBoard::circled(), resize(), scaleToHeight(), scaleToWidth(), LibBoard::tiling(), LibBoard::BoundingBoxViewer::visit(), LibBoard::BoundingBoxExtractor::visit(), and LibBoard::BoundingBoxViewer::visit().

center()

Point LibBoard::Shape::center ( LineWidthFlag  lineWidthFlag = IgnoreLineWidth ) const

virtual

Returns the center of the shape.

Parameters

lineWidthFlag

Should the line width be considered when computing bounding boxes.

Returns

The center of the shape, i.e. the center of its bounding box.

Reimplemented in LibBoard::Dot, LibBoard::Ellipse, and LibBoard::Text.

Examples

examples/Huffman.cpp, examples/example1.cpp, examples/images.cpp, and examples/traversal.cpp.

References boundingBox(), and LibBoard::Rect::center().

Referenced by LibBoard::Group::accept(), LibBoard::Group::accept(), LibBoard::Group::accept(), main(), merge(), moveCenter(), moveCenter(), LibBoard::Board::rotate(), LibBoard::Bezier::rotate(), LibBoard::Group::rotate(), LibBoard::Image::rotate(), LibBoard::Line::rotate(), LibBoard::Polyline::rotate(), LibBoard::GouraudTriangle::rotate(), LibBoard::Board::rotate(), LibBoard::Bezier::rotate(), LibBoard::Group::rotate(), LibBoard::Image::rotate(), LibBoard::Line::rotate(), LibBoard::Polyline::rotate(), LibBoard::GouraudTriangle::rotate(), LibBoard::ShapeList::rotated(), LibBoard::Bezier::rotated(), LibBoard::Line::rotated(), LibBoard::Polyline::rotated(), LibBoard::GouraudTriangle::rotated(), LibBoard::Image::rotated(), LibBoard::Board::rotated(), LibBoard::Group::rotated(), LibBoard::Arrow::rotated(), LibBoard::Bezier::rotated(), LibBoard::Line::rotated(), LibBoard::Polyline::rotated(), LibBoard::GouraudTriangle::rotated(), rotateDeg(), rotateDeg(), LibBoard::Board::scale(), LibBoard::Group::scale(), LibBoard::Board::scale(), LibBoard::Group::scale(), LibBoard::Image::scale(), LibBoard::Line::scale(), and LibBoard::ShapeList::scale().

clone()

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

pure virtual

Return a copy of the shape.

Returns

A copy of the shape.

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

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

flushFIG()

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

pure virtual

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

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

flushPostscript()

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

pure virtual

Write 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::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::GouraudTriangle, LibBoard::ShapeList, and LibBoard::Text.

flushSVG()

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

pure virtual

Write 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::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::GouraudTriangle, LibBoard::ShapeList, and LibBoard::Text.

flushTikZ()

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

pure virtual

Write 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::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::GouraudTriangle, LibBoard::ShapeList, and LibBoard::Text.

moveCenter() [1/2]

Shape & LibBoard::Shape::moveCenter	(	double	x,
		double	y,
		LineWidthFlag	lineWidthFlag = IgnoreLineWidth
	)

Move the center of the shape.

Parameters

x	The new x coordinate of the center.
y	The new y coordinate of the center.
lineWidthFlag	Should the line width be considered when computing bounding boxes.

Returns

A reference to the shape itself.

Examples

examples/Huffman.cpp, examples/images.cpp, and examples/xkcd.cpp.

References center(), translate(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by LibBoard::ShapeList::append(), LibBoard::hachures(), main(), and merge().

moveCenter() [2/2]

Shape & LibBoard::Shape::moveCenter	(	Point	p,
		LineWidthFlag	lineWidthFlag = IgnoreLineWidth
	)

Move the center of the shape.

Parameters

p	The new center.
lineWidthFlag	Should the line width be considered when computing bounding boxes.

Returns

A reference to the shape itself.

References center(), translate(), LibBoard::Point::x, and LibBoard::Point::y.

name()

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

virtual

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

Returns

Reimplemented in LibBoard::ShapeWithStyle, LibBoard::Arrow, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::GouraudTriangle, LibBoard::ShapeList, and LibBoard::Text.

Referenced by LibBoard::BoundingBoxViewer::visit(), and LibBoard::BoundingBoxViewer::visit().

resize()

Shape & LibBoard::Shape::resize	(	double	width,
		double	height,
		LineWidthFlag	lineWidthFlag
	)

Resize the shape.

Parameters

width	The new width.
height	The new height.
lineWidthFlag	Should the line width be considered when computing bounding boxes.

Returns

The shape itself.

References bbox(), boundingBox(), LibBoard::Rect::height, scale(), and LibBoard::Rect::width.

Referenced by LibBoard::Arrow::resized(), LibBoard::Bezier::resized(), LibBoard::Ellipse::resized(), LibBoard::Line::resized(), LibBoard::Polyline::resized(), and LibBoard::GouraudTriangle::resized().

rotate() [1/2]

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::Board, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::GouraudTriangle, LibBoard::ShapeList, and LibBoard::Text.

rotate() [2/2]

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::Board, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::GouraudTriangle, LibBoard::ShapeList, and LibBoard::Text.

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

rotateDeg() [1/2]

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

inline

Rotate the shape around its center.

Parameters

angle

The rotation angle in degree.

Returns

A reference to the shape itself.

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

rotateDeg() [2/2]

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.

Examples

examples/example4.cpp, examples/images.cpp, examples/tilings.cpp, and examples/xkcd.cpp.

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

Referenced by main().

scale() [1/2]

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

pure virtual

Scale the shape along both axis.

Parameters

s	The scaling factor along both axis.

Returns

The shape itself.

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

scale() [2/2]

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

pure virtual

Scale the shape along the x an y axis.

Parameters

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

Returns

The shape itself.

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

Referenced by LibBoard::Board::addDuplicates(), LibBoard::Board::addDuplicates(), LibBoard::ShapeList::addRepeated(), resize(), scaleToHeight(), scaleToWidth(), LibBoard::ShapeList::ShapeList(), and LibBoard::ShapeList::ShapeList().

scaleAll()

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

pure virtual

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

Parameters

s	The scaling factor.

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

Referenced by LibBoard::ShapeList::addShape().

scaleToHeight()

Shape & LibBoard::Shape::scaleToHeight	(	double	h,
		LineWidthFlag	lineWidthFlag
	)

Scale the shape to a given height.

Parameters

h	The requested new height.
lineWidthFlag	Should the line width be considered when computing bounding boxes.

Returns

The shape itself.

References boundingBox(), LibBoard::Rect::height, and scale().

scaleToWidth()

Shape & LibBoard::Shape::scaleToWidth	(	double	w,
		LineWidthFlag	lineWidthFlag
	)

Scale the shape to a given width.

Parameters

w	The requested new width.
lineWidthFlag	Should the line width be considered when computing bounding boxes.

Returns

The shape itself.

Examples

examples/arithmetic.cpp, examples/arrows.cpp, examples/clipping.cpp, examples/example4.cpp, examples/flag.cpp, examples/graph.cpp, examples/holes.cpp, examples/images.cpp, examples/koch.cpp, examples/line_segment.cpp, examples/line_style.cpp, examples/logo.cpp, examples/ruler.cpp, examples/scale_ellipse.cpp, examples/sierpinski.cpp, examples/stroke_path.cpp, and examples/tilings.cpp.

References boundingBox(), scale(), and LibBoard::Rect::width.

Referenced by main(), and main().

translate()

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::Board, LibBoard::Bezier, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Group, LibBoard::Image, LibBoard::Line, LibBoard::Polyline, LibBoard::ShapeList, and LibBoard::Text.

Referenced by LibBoard::Board::addDuplicates(), LibBoard::Board::addDuplicates(), LibBoard::ShapeList::addRepeated(), moveCenter(), moveCenter(), LibBoard::ShapeList::ShapeList(), LibBoard::ShapeList::ShapeList(), and LibBoard::tiling().

---

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

• include/board/Shape.h
• src/Shape.cpp