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

#include <Shapes.h>

Inheritance diagram for LibBoard::Polyline:

Public Member Functions
	Polyline (const std::vector< Point > &points, bool closed, Color penColor=Shape::defaultPenColor(), Color fillColor=Shape::defaultFillColor(), double lineWidth=Shape::defaultLineWidth(), const LineStyle lineStyle=Shape::defaultLineStyle(), const LineCap cap=Shape::defaultLineCap(), const LineJoin join=Shape::defaultLineJoin(), int depth=-1)

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

	Polyline (bool closed, Color penColor=Shape::defaultPenColor(), Color fillColor=Shape::defaultFillColor(), double lineWidth=Shape::defaultLineWidth(), const LineStyle lineStyle=Shape::defaultLineStyle(), const LineCap cap=Shape::defaultLineCap(), const LineJoin join=Shape::defaultLineJoin(), int depth=-1)

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

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

Rect	boundingBox (LineWidthFlag) const override

Polyline *	clone () const override

std::size_t	vertexCount () const

const Path &	path () const

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

virtual	~Shape ()

bool	filled () const

virtual Point	center (LineWidthFlag lineWidthFlag=IgnoreLineWidth) const

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

Shape &	rotateDeg (double angle)

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

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

Shape &	scaleToWidth (double w, LineWidthFlag lineWidthFlag)

Shape &	scaleToHeight (double h, LineWidthFlag lineWidthFlag)

Rect	bbox (LineWidthFlag) const

Shape &	operator-- ()

Shape &	operator++ ()

int	depth () const

virtual void	depth (int)

virtual void	shiftDepth (int shift)

const Color &	penColor () const

const Color &	fillColor () const

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

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

Protected Attributes
Path	_path

Protected Attributes inherited from LibBoard::Shape
int	_depth

Color	_penColor

Color	_fillColor

double	_lineWidth

LineStyle	_lineStyle

LineCap	_lineCap

LineJoin	_lineJoin

Additional Inherited Members
Public Types inherited from LibBoard::Shape
enum	LineCap { ButtCap = 0, RoundCap, SquareCap }

enum	LineJoin { MiterJoin = 0, RoundJoin, BevelJoin }

enum	LineStyle { SolidStyle = 0, DashStyle, DotStyle, DashDotStyle, DashDotDotStyle, DashDotDotDotStyle }

enum	LineWidthFlag { IgnoreLineWidth, UseLineWidth }

Static Public Member Functions inherited from LibBoard::Shape
static void	enableLineWidthScaling ()

static void	disableLineWidthScaling ()

static void	setLineWidthScaling (bool)

static void	setDefaultLineWidth (double)

static void	setDefaultPenColor (Color)

static void	setDefaultFillColor (Color)

static void	setDefaultLineStyle (Shape::LineStyle)

static void	setDefaultLineCap (Shape::LineCap)

static void	setDefaultLineJoin (Shape::LineJoin)

static double	defaultLineWidth ()
	defaultLineWidth More...

static Color	defaultPenColor ()
	defaultPenColor More...

static Color	defaultFillColor ()
	defaultFillColor More...

static Shape::LineStyle	defaultLineStyle ()
	defaultLineStyle More...

static Shape::LineCap	defaultLineCap ()
	defaultLineCap More...

static Shape::LineJoin	defaultLineJoin ()
	defaultLineJoin More...

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

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

std::string	postscriptProperties (const TransformEPS &transform) const

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

Static Protected Attributes inherited from LibBoard::Shape
static bool	_lineWidthScaling = true

static double	_defaultLineWidth = 1.0

static Color	_defaultPenColor = Color::Black

static Color	_defaultFillColor = Color::Null

static Shape::LineStyle	_defaultLineStyle = Shape::SolidStyle

static Shape::LineCap	_defaultLineCap = Shape::ButtCap

static Shape::LineJoin	_defaultLineJoin = Shape::MiterJoin

Detailed Description

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

The polyline structure.

Examples:: examples/koch.cpp, examples/stroke_path.cpp, and examples/tilings.cpp.

Member Function Documentation

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

overridevirtual

Compute the bounding box of the figure.

Returns: The rectangle of the bounding box.

Implements LibBoard::Shape.

References LibBoard::Shape::_lineCap, LibBoard::Shape::_lineJoin, LibBoard::Shape::_lineWidth, and LibBoard::Path::boundingBox().

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

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

overridevirtual

Return a copy of the shape.

Returns: A copy of the shape.

Implements LibBoard::Shape.

Reimplemented in LibBoard::GouraudTriangle, LibBoard::Triangle, and LibBoard::Rectangle.

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.

Implements LibBoard::Shape.

Reimplemented in LibBoard::GouraudTriangle, and LibBoard::Rectangle.

References LibBoard::Shape::_depth, LibBoard::Shape::_fillColor, LibBoard::Shape::_lineCap, LibBoard::Shape::_lineJoin, LibBoard::Shape::_lineStyle, LibBoard::Shape::_lineWidth, LibBoard::Shape::_penColor, and LibBoard::Shape::filled().

Referenced by LibBoard::Rectangle::flushFIG(), and LibBoard::GouraudTriangle::flushFIG().

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.

Reimplemented in LibBoard::GouraudTriangle.

References LibBoard::Shape::_fillColor, LibBoard::Shape::_penColor, LibBoard::Shape::filled(), and LibBoard::Shape::postscriptProperties().

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

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.

Reimplemented in LibBoard::GouraudTriangle, and LibBoard::Rectangle.

References LibBoard::Shape::svgProperties().

Referenced by LibBoard::Rectangle::flushSVG(), and LibBoard::GouraudTriangle::flushSVG().

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.

Reimplemented in LibBoard::GouraudTriangle, and LibBoard::Rectangle.

References LibBoard::Shape::tikzProperties().

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

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.

Reimplemented in LibBoard::GouraudTriangle, LibBoard::Triangle, and LibBoard::Rectangle.

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

Add a point to the polyline.

Parameters

p

Returns

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

inline

Returns the n-th point of the polyline.

Parameters

i

Returns

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

inline

Returns the n-th point of the polyline.

Parameters

i

Returns

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.

Reimplemented in LibBoard::GouraudTriangle.

References LibBoard::Path::rotate().

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

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.

Reimplemented in LibBoard::GouraudTriangle.

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

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

Parameters

angle
center

Returns

References rotate().

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

Parameters

angle

Returns

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

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 LibBoard::Path::scale().

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

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

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.

Reimplemented in LibBoard::GouraudTriangle, and LibBoard::Rectangle.

References LibBoard::Path::scaleAll().

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

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

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 LibBoard::Path::translate().

Referenced by LibBoard::Image::translate(), translated(), LibBoard::Rectangle::translated(), LibBoard::Triangle::translated(), and LibBoard::GouraudTriangle::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.

References translate().

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

include/board/Shapes.h
src/Shapes.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation