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

virtual void	accept (const ShapeVisitor &visitor)
	Accepts a visitor object. More...

virtual void	accept (ConstShapeVisitor &visitor) const
	Accepts a const-shape visitor object. More...

virtual void	accept (const ConstShapeVisitor &visitor) const
	Accepts a const-shape visitor object. More...

virtual Shape *	accept (CompositeShapeTransform &transform) const
	Accept a composite shape transform. More...

virtual Shape *	accept (const CompositeShapeTransform &transform) const
	Accept a constant composite shape transform. More...

	Shape (const Shape &other)

Detailed Description

Abstract structure for a 2D shape.

Shape structure.

Examples: examples/traversal.cpp.

Constructor & Destructor Documentation

◆ Shape()

LibBoard::Shape::Shape ( )

inline

Shape constructor.

◆ ~Shape()

LibBoard::Shape::~Shape ( )

virtual

Shape destructor.

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

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

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

◆ accept() [4/6]

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

virtual

Accepts a visitor object.

Parameters

visitor A visitor object.

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

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

◆ accept() [6/6]

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

virtual

Accepts a visitor object.

Parameters

visitor A visitor object.

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

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

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

References boundingBox().

Referenced by LibBoard::Board::drawBoundingBox(), LibBoard::Group::flushFIG(), LibBoard::Image::flushFIG(), resize(), 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::Bezier, LibBoard::Polyline, LibBoard::Text, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Line, LibBoard::Arrow, LibBoard::ShapeList, LibBoard::Group, and LibBoard::Image.

Referenced by LibBoard::ShapeList::addTiling(), LibBoard::ShapeList::append(), bbox(), center(), resize(), scaleToHeight(), and scaleToWidth().

◆ 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::Text, LibBoard::Ellipse, and LibBoard::Dot.

Examples: examples/example1.cpp, examples/images.cpp, and examples/traversal.cpp.

References boundingBox().

Referenced by moveCenter(), LibBoard::Group::rotate(), LibBoard::Polyline::rotate(), LibBoard::Image::rotate(), LibBoard::Line::rotate(), LibBoard::ShapeList::rotate(), LibBoard::Bezier::rotate(), LibBoard::Board::rotate(), LibBoard::GouraudTriangle::rotate(), LibBoard::Polyline::rotated(), LibBoard::Line::rotated(), LibBoard::Image::rotated(), LibBoard::ShapeList::rotated(), LibBoard::Arrow::rotated(), LibBoard::Bezier::rotated(), LibBoard::Board::rotated(), LibBoard::Group::scale(), LibBoard::ShapeList::scale(), LibBoard::Image::scale(), LibBoard::Line::scale(), and LibBoard::Board::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::GouraudTriangle, LibBoard::Bezier, LibBoard::Polyline, LibBoard::Arrow, LibBoard::Text, LibBoard::Dot, LibBoard::Ellipse, LibBoard::Line, LibBoard::ShapeList, LibBoard::Group, LibBoard::Image, and LibBoard::ShapeWithStyle.

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

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

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

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

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

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

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

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

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

◆ 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/images.cpp.

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

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

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

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

Referenced by LibBoard::Board::addDuplicates(), LibBoard::ShapeList::repeat(), 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 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, and examples/tilings.cpp.

References rotate().

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

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

Referenced by LibBoard::Board::addDuplicates(), LibBoard::ShapeList::repeat(), resize(), scaleToHeight(), scaleToWidth(), 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::GouraudTriangle, LibBoard::Bezier, LibBoard::Line, LibBoard::Image, LibBoard::Polyline, LibBoard::Text, LibBoard::ShapeList, LibBoard::Dot, and LibBoard::Ellipse.

◆ 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/stroke_path.cpp, and examples/tilings.cpp.

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

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

Referenced by LibBoard::Board::addDuplicates(), LibBoard::ShapeList::addTiling(), moveCenter(), LibBoard::ShapeList::repeat(), and LibBoard::ShapeList::ShapeList().

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Shape()

◆ ~Shape()

Member Function Documentation

◆ accept() [1/6]

◆ accept() [2/6]

◆ accept() [3/6]

◆ accept() [4/6]

◆ accept() [5/6]

◆ accept() [6/6]

◆ bbox()

◆ boundingBox()

◆ center()

◆ clone()

◆ flushFIG()

◆ flushPostscript()

◆ flushSVG()

◆ flushTikZ()

◆ moveCenter() [1/2]

◆ moveCenter() [2/2]

◆ name()

◆ resize()

◆ rotate() [1/2]

◆ rotate() [2/2]

◆ rotateDeg() [1/2]

◆ rotateDeg() [2/2]

◆ scale() [1/2]

◆ scale() [2/2]

◆ scaleAll()

◆ scaleToHeight()

◆ scaleToWidth()

◆ translate()