A polygonal line described by a series of 2D points. More...

#include <Polyline.h>

Inheritance diagram for LibBoard::Polyline:

Public Member Functions
	Polyline (const std::vector< Point > &points, Path::OpenClosed openClosed, Color penColor=Style::defaultPenColor(), Color fillColor=Style::defaultFillColor(), double lineWidth=Style::defaultLineWidth(), const LineStyle lineStyle=Style::defaultLineStyle(), const LineCap cap=Style::defaultLineCap(), const LineJoin join=Style::defaultLineJoin())

	Polyline (const std::vector< Point > &points, Path::OpenClosed openClosed, const Style &style)

	Polyline (const Path &path, Color penColor=Style::defaultPenColor(), Color fillColor=Style::defaultFillColor(), double lineWidth=Style::defaultLineWidth(), const LineStyle lineStyle=Style::defaultLineStyle(), const LineCap cap=Style::defaultLineCap(), const LineJoin join=Style::defaultLineJoin())

	Polyline (const Path &path, const Style &style)

	Polyline (Path::OpenClosed openClosed, Color penColor=Style::defaultPenColor(), Color fillColor=Style::defaultFillColor(), double lineWidth=Style::defaultLineWidth(), const LineStyle lineStyle=Style::defaultLineStyle(), const LineCap cap=Style::defaultLineCap(), const LineJoin join=Style::defaultLineJoin())

	Polyline (Path::OpenClosed openClosed, const Style &style)

const std::string &	name () const override

Polyline &	operator<< (const Point &p)

Point &	operator[] (const std::size_t n)

const Point &	operator[] (const std::size_t n) const

Polyline &	rotate (double angle, const Point &center) override

Polyline	rotated (double angle, const Point &center) const

Polyline &	rotate (double angle) override

Polyline	rotated (double angle) const

Polyline &	translate (double dx, double dy) override

Polyline	translated (double dx, double dy) const

Polyline &	scale (double sx, double sy) override

Polyline &	scale (double s) override

Polyline	scaled (double sx, double sy) const

Polyline	scaled (double s) const

void	scaleAll (double s) override

Polyline	resized (double w, double h, LineWidthFlag lineWidthFlag) const

void	addHole (const Path &path)
	Add a hole to the path. Warning: Hole share the polyline line style.

void	flushPostscript (std::ostream &stream, const TransformEPS &transform) const override

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

void	flushSVG (std::ostream &stream, const TransformSVG &transform) const override

void	flushTikZ (std::ostream &stream, const TransformTikZ &transform) const override

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

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

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

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

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

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

Rect	boundingBox (LineWidthFlag) const override

Polyline *	clone () const override

std::size_t	vertexCount () const

const Path &	path () const

void	setRectangleFlag ()

	Polyline (const Polyline &)=default

	Polyline (Polyline &&)=default

Polyline &	operator= (Polyline &&)=default

Polyline &	operator= (const Polyline &)=default

	~Polyline () override=default

Public Member Functions inherited from LibBoard::ShapeWithStyle
	ShapeWithStyle (Color penColor, Color fillColor, double lineWidth, LineStyle style, const LineCap cap, const LineJoin join)

	ShapeWithStyle (const Style &style)

	ShapeWithStyle (const ShapeWithStyle &other)

ShapeWithStyle &	operator= (const ShapeWithStyle &other)

	~ShapeWithStyle ()

const std::string &	name () const

Shape *	clone () const =0

const Color &	penColor () const

ShapeWithStyle &	setPenColor (const Color &)

const Color &	fillColor () const

ShapeWithStyle &	setFillColor (const Color &)

double	lineWidth () const

ShapeWithStyle &	setLineWidth (double)

LineStyle	lineStyle () const

ShapeWithStyle &	setLineStyle (LineStyle)

LineCap	lineCap () const

ShapeWithStyle &	setLineCap (LineCap)

LineJoin	lineJoin () const

ShapeWithStyle &	setLineJoin (LineJoin)

Style	style () const

ShapeWithStyle &	setStyle (const Style &)

bool	filled () const

Public Member Functions inherited from LibBoard::Shape
	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)

Protected Attributes
Path	_path

std::vector< Path >	_holes

Protected Attributes inherited from LibBoard::ShapeWithStyle
Style	_style

Additional Inherited Members
Static Public Member Functions inherited from LibBoard::ShapeWithStyle
static void	setLineWidthScaling (bool)

Protected Member Functions inherited from LibBoard::ShapeWithStyle
void	updateLineWidth (double s)

Detailed Description

A polygonal line described by a series of 2D points.

The polyline structure.

Examples: examples/Huffman.cpp, examples/arrows.cpp, examples/bezier.cpp, examples/example4.cpp, examples/holes.cpp, examples/hull.cpp, examples/images.cpp, examples/interpolate.cpp, examples/koch.cpp, examples/rough.cpp, examples/sandbox.cpp, examples/sierpinski.cpp, examples/stroke_path.cpp, examples/test_depth.cpp, examples/tilings.cpp, examples/traversal.cpp, and examples/triangles.cpp.

Constructor & Destructor Documentation

◆ Polyline() [1/8]

LibBoard::Polyline::Polyline	(	const std::vector< Point > &	points,
		Path::OpenClosed	openClosed,
		Color	penColor = `Style::defaultPenColor()`,
		Color	fillColor = `Style::defaultFillColor()`,
		double	lineWidth = `Style::defaultLineWidth()`,
		const LineStyle	lineStyle = `Style::defaultLineStyle()`,
		const LineCap	cap = `Style::defaultLineCap()`,
		const LineJoin	join = `Style::defaultLineJoin()`
	)

inline

◆ Polyline() [2/8]

LibBoard::Polyline::Polyline	(	const std::vector< Point > &	points,
		Path::OpenClosed	openClosed,
		const Style &	style
	)

inline

◆ Polyline() [3/8]

LibBoard::Polyline::Polyline	(	const Path &	path,
		Color	penColor = `Style::defaultPenColor()`,
		Color	fillColor = `Style::defaultFillColor()`,
		double	lineWidth = `Style::defaultLineWidth()`,
		const LineStyle	lineStyle = `Style::defaultLineStyle()`,
		const LineCap	cap = `Style::defaultLineCap()`,
		const LineJoin	join = `Style::defaultLineJoin()`
	)

inline

◆ Polyline() [4/8]

LibBoard::Polyline::Polyline	(	const Path &	path,
		const Style &	style
	)

inline

◆ Polyline() [5/8]

LibBoard::Polyline::Polyline	(	Path::OpenClosed	openClosed,
		Color	penColor = `Style::defaultPenColor()`,
		Color	fillColor = `Style::defaultFillColor()`,
		double	lineWidth = `Style::defaultLineWidth()`,
		const LineStyle	lineStyle = `Style::defaultLineStyle()`,
		const LineCap	cap = `Style::defaultLineCap()`,
		const LineJoin	join = `Style::defaultLineJoin()`
	)

inline

◆ Polyline() [6/8]

LibBoard::Polyline::Polyline	(	Path::OpenClosed	openClosed,
		const Style &	style
	)

inline

◆ Polyline() [7/8]

LibBoard::Polyline::Polyline ( const Polyline & )

default

◆ Polyline() [8/8]

LibBoard::Polyline::Polyline ( Polyline && )

default

◆ ~Polyline()

LibBoard::Polyline::~Polyline ( )

overridedefault

Member Function Documentation

◆ accept() [1/6]

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

overridevirtual

Accept a composite shape transform.

Parameters

transform A composite shape transform object.

Reimplemented from LibBoard::Shape.

References LibBoard::CompositeShapeTransform::map().

◆ accept() [2/6]

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

overridevirtual

Accept a constant composite shape transform.

Parameters

transform A constant composite shape transform object..

Reimplemented from LibBoard::Shape.

References LibBoard::CompositeShapeTransform::map().

◆ accept() [3/6]

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

overridevirtual

Accepts a const-shape visitor object.

Parameters

visitor A const-shape visitor object.

Reimplemented from LibBoard::Shape.

References LibBoard::ConstShapeVisitor::visit().

◆ accept() [4/6]

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

overridevirtual

Accepts a visitor object.

Parameters

visitor A visitor object.

Reimplemented from LibBoard::Shape.

References LibBoard::ShapeVisitor::visit().

◆ accept() [5/6]

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

overridevirtual

Accepts a const-shape visitor object.

Parameters

visitor A const-shape visitor object.

Reimplemented from LibBoard::Shape.

References LibBoard::ConstShapeVisitor::visit().

◆ accept() [6/6]

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

overridevirtual

Accepts a visitor object.

Parameters

visitor A visitor object.

Reimplemented from LibBoard::Shape.

References LibBoard::ShapeVisitor::visit().

◆ addHole()

void LibBoard::Polyline::addHole ( const Path & path )

Add a hole to the path. Warning: Hole share the polyline line style.

Parameters

path	Vertices of the polyline

Examples: examples/holes.cpp.

References _holes, and path().

Referenced by main().

◆ boundingBox()

Rect LibBoard::Polyline::boundingBox ( LineWidthFlag ) const

overridevirtual

Compute the bounding box of the figure.

Returns: The rectangle of the bounding box.

Implements LibBoard::Shape.

Examples: examples/sandbox.cpp.

References _path, LibBoard::Path::boundingBox(), LibBoard::IgnoreLineWidth, LibBoard::ShapeWithStyle::lineCap(), LibBoard::ShapeWithStyle::lineJoin(), LibBoard::ShapeWithStyle::lineWidth(), LibBoard::Tools::pathBoundingBox(), and LibBoard::UseLineWidth.

Referenced by LibBoard::Image::boundingBox(), LibBoard::Image::flushFIG(), and main().

◆ clone()

Polyline * LibBoard::Polyline::clone ( ) const

overridevirtual

Return a copy of the shape.

Returns: A copy of the shape.

Implements LibBoard::ShapeWithStyle.

Referenced by LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawRectangle(), and LibBoard::Board::drawRectangle().

◆ flushFIG()

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

overridevirtual

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

Implements LibBoard::Shape.

References _path, LibBoard::Tools::almostEqual(), LibBoard::Path::empty(), LibBoard::ShapeWithStyle::fillColor(), LibBoard::ShapeWithStyle::filled(), LibBoard::Path::flushFIG(), LibBoard::Path::isClosed(), LibBoard::ShapeWithStyle::lineCap(), LibBoard::ShapeWithStyle::lineJoin(), LibBoard::ShapeWithStyle::lineStyle(), LibBoard::ShapeWithStyle::lineWidth(), LibBoard::TransformFIG::mapWidth(), LibBoard::ShapeWithStyle::penColor(), LibBoard::TransformFIG::shapeDepth(), LibBoard::Path::size(), LibBoard::Color::valid(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by LibBoard::Image::flushFIG(), LibBoard::GouraudTriangle::flushFIG(), and LibBoard::Board::saveFIG().

◆ flushPostscript()

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

overridevirtual

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.

Implements LibBoard::Shape.

References _holes, _path, LibBoard::ShapeWithStyle::_style, LibBoard::Path::empty(), LibBoard::ShapeWithStyle::fillColor(), LibBoard::ShapeWithStyle::filled(), LibBoard::Color::flushPostscript(), LibBoard::Path::flushPostscript(), LibBoard::Path::getClockwise(), LibBoard::ShapeWithStyle::lineWidth(), LibBoard::Color::Null, LibBoard::ShapeWithStyle::penColor(), and LibBoard::Style::postscriptProperties().

Referenced by LibBoard::Arrow::flushPostscript(), LibBoard::GouraudTriangle::flushPostscript(), and LibBoard::Board::saveEPS().

◆ flushSVG()

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

overridevirtual

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.

Implements LibBoard::Shape.

References _holes, _path, LibBoard::ShapeWithStyle::_style, LibBoard::Path::close(), LibBoard::Path::empty(), LibBoard::Path::flushSVGCommands(), LibBoard::Path::flushSVGPoints(), LibBoard::Path::getClockwise(), LibBoard::Path::isClosed(), LibBoard::orthogonal(), LibBoard::Path::setCounterclockwise(), LibBoard::Path::size(), and LibBoard::Style::svgProperties().

Referenced by LibBoard::Arrow::flushSVG(), LibBoard::GouraudTriangle::flushSVG(), and LibBoard::Board::saveSVG().

◆ flushTikZ()

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

overridevirtual

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.

Implements LibBoard::Shape.

References _path, LibBoard::ShapeWithStyle::_style, LibBoard::Path::empty(), LibBoard::Path::flushTikZPoints(), LibBoard::Path::isClosed(), and LibBoard::Style::tikzProperties().

Referenced by LibBoard::Image::flushTikZ(), and LibBoard::Board::saveTikZ().

◆ name()

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

overridevirtual

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

Returns

Reimplemented from LibBoard::Shape.

◆ operator<<()

Polyline & LibBoard::Polyline::operator<< ( const Point & p )

Add a point to the polyline.

Parameters

p

Returns

References _path.

◆ operator=() [1/2]

Polyline & LibBoard::Polyline::operator= ( const Polyline & )

default

◆ operator=() [2/2]

Polyline & LibBoard::Polyline::operator= ( Polyline && )

default

◆ operator[]() [1/2]

Point & LibBoard::Polyline::operator[] ( const std::size_t n )

inline

Returns the n-th point of the polyline.

Parameters

n

Returns: A reference to the n-th point of the polyline.

References _path.

◆ operator[]() [2/2]

const Point & LibBoard::Polyline::operator[] ( const std::size_t n ) const

inline

Returns the n-th point of the polyline.

Parameters

n

Returns: A constant reference to the n-th point of the polyline.

References _path.

◆ path()

const Path & LibBoard::Polyline::path ( ) const

inline

Examples: examples/rough.cpp, and examples/triangles.cpp.

References _path.

Referenced by addHole(), divided(), hachures(), main(), LibBoard::RoughVisitor::map(), LibBoard::mix(), and polygons().

◆ resized()

Polyline LibBoard::Polyline::resized	(	double	w,
		double	h,
		LineWidthFlag	lineWidthFlag
	)		const

Returns a resized copy of the polyline.

Parameters

w	Width of the new polyline.
h	Height of the new polyline.
lineWidthFlag	Should the line width be considered when computing bounding boxes.

Returns: A resized copy of the polyline.

References LibBoard::Shape::resize().

◆ rotate() [1/2]

Polyline & LibBoard::Polyline::rotate ( double angle )

overridevirtual

Rotate the shape around its center.

Parameters

angle The rotation angle in radian.

Returns: A reference to the shape itself.

Implements LibBoard::Shape.

References LibBoard::Shape::center(), and rotate().

◆ rotate() [2/2]

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

overridevirtual

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.

Implements LibBoard::Shape.

Examples: examples/rough.cpp.

References _holes, _path, LibBoard::Shape::center(), and LibBoard::Path::rotate().

Referenced by hachures(), polygons(), LibBoard::Image::rotate(), rotate(), LibBoard::Image::rotate(), rotated(), and rotated().

◆ rotated() [1/2]

Polyline LibBoard::Polyline::rotated ( double angle ) const

Parameters

angle

Returns

References LibBoard::Shape::center(), and rotate().

◆ rotated() [2/2]

Polyline LibBoard::Polyline::rotated	(	double	angle,
		const Point &	center
	)		const

Parameters

angle
center

Returns

Examples: examples/example4.cpp, and examples/sandbox.cpp.

References LibBoard::Shape::center(), and rotate().

Referenced by main().

◆ scale() [1/2]

Polyline & LibBoard::Polyline::scale ( double s )

overridevirtual

Scale the polyline, given a scaling factor.

Parameters

s	Scaling factor.

Returns: A reference to the polyline itself, once scaled.

Implements LibBoard::Shape.

References scale().

◆ scale() [2/2]

Polyline & LibBoard::Polyline::scale	(	double	sx,
		double	sy
	)

overridevirtual

Scale the polyline, given two scaling factors.

Parameters

sx	Scaling factor along the x axis.
sy	Scaling factor along the y axis.

Returns: A reference to the polyline itself, once scaled.

Implements LibBoard::Shape.

References _holes, _path, LibBoard::Path::center(), LibBoard::Path::moveCenter(), LibBoard::Path::scale(), LibBoard::ShapeWithStyle::updateLineWidth(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by scale(), LibBoard::Image::scale(), scaled(), LibBoard::GouraudTriangle::scaled(), scaled(), and LibBoard::GouraudTriangle::scaled().

◆ scaleAll()

void LibBoard::Polyline::scaleAll ( double s )

overridevirtual

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

Parameters

s	The scaling factor.

Implements LibBoard::Shape.

References _holes, _path, and LibBoard::Path::scaleAll().

Referenced by LibBoard::Image::scaleAll().

◆ scaled() [1/2]

Polyline LibBoard::Polyline::scaled ( double s ) const

Returns a scaled copy of the line.

Parameters

s	The scaling factor.

Returns: A scaled copy of the line.

References scale().

◆ scaled() [2/2]

Polyline LibBoard::Polyline::scaled	(	double	sx,
		double	sy
	)		const

Returns a scaled copy of the line.

Parameters

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

Returns: A scaled copy of the line.

References scale().

◆ setRectangleFlag()

void LibBoard::Polyline::setRectangleFlag ( )

Referenced by LibBoard::rectangle().

◆ translate()

Polyline & LibBoard::Polyline::translate	(	double	dx,
		double	dy
	)

overridevirtual

Translate the polyline by a given offset.

Parameters

dx	The x offset.
dy	The y offset.

Returns: A reference to the polyline itself.

Implements LibBoard::Shape.

References _holes, _path, and LibBoard::Path::translate().

Referenced by LibBoard::Image::translate(), translated(), and LibBoard::GouraudTriangle::translated().

◆ translated()

Polyline LibBoard::Polyline::translated	(	double	dx,
		double	dy
	)		const

Returns a translated copy of the polyline.

Parameters

dx	Shift of the first coordinate.
dy	Shift of the second coordinate.

Returns: A copy of the polyline, translated.

Examples: examples/example4.cpp, examples/sandbox.cpp, and examples/test_depth.cpp.

References translate().

Referenced by main().

◆ vertexCount()

std::size_t LibBoard::Polyline::vertexCount ( ) const

inline

Examples: examples/triangles.cpp.

References _path, and LibBoard::Path::size().

Referenced by divided(), LibBoard::Image::flushFIG(), and main().

Member Data Documentation

◆ _holes

std::vector<Path> LibBoard::Polyline::_holes

protected

Referenced by addHole(), flushPostscript(), flushSVG(), rotate(), scale(), scaleAll(), and translate().

◆ _path

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

include/board/Polyline.h
src/Polyline.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Polyline() [1/8]

◆ Polyline() [2/8]

◆ Polyline() [3/8]

◆ Polyline() [4/8]

◆ Polyline() [5/8]

◆ Polyline() [6/8]

◆ Polyline() [7/8]

◆ Polyline() [8/8]

◆ ~Polyline()

Member Function Documentation

◆ accept() [1/6]

◆ accept() [2/6]

◆ accept() [3/6]

◆ accept() [4/6]

◆ accept() [5/6]

◆ accept() [6/6]

◆ addHole()

◆ boundingBox()

◆ clone()

◆ flushFIG()

◆ flushPostscript()

◆ flushSVG()

◆ flushTikZ()

◆ name()

◆ operator<<()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ path()

◆ resized()

◆ rotate() [1/2]

◆ rotate() [2/2]

◆ rotated() [1/2]

◆ rotated() [2/2]

◆ scale() [1/2]

◆ scale() [2/2]

◆ scaleAll()

◆ scaled() [1/2]

◆ scaled() [2/2]

◆ setRectangleFlag()

◆ translate()

◆ translated()

◆ vertexCount()

Member Data Documentation

◆ _holes

◆ _path