A line between two points. More...

#include <Line.h>

Inheritance diagram for LibBoard::Line:

Public Member Functions
	Line (double x1, double y1, double x2, double y2, Color color, double lineWidth=Style::defaultLineWidth(), const LineStyle lineStyle=Style::defaultLineStyle(), const LineCap cap=Style::defaultLineCap(), const LineJoin join=Style::defaultLineJoin())

	Line (double x1, double y1, double x2, double y2, const Style &style)

	Line (Point a, Point b, Color color, double lineWidth=Style::defaultLineWidth(), const LineStyle lineStyle=Style::defaultLineStyle(), const LineCap cap=Style::defaultLineCap(), const LineJoin join=Style::defaultLineJoin())

	Line (Point a, Point b, const Style &style)

const std::string &	name () const override

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

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

Line &	rotate (double angle) override

Line	rotated (double angle) const

Line &	translate (double dx, double dy) override

Line	translated (double dx, double dy) const

Line &	scale (double sx, double sy) override

Line &	scale (double s) override

Line	scaled (double sx, double sy) const

Line	scaled (double s) const

void	scaleAll (double s) override

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

Rect	boundingBox (LineWidthFlag) const override

Line *	clone () const 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

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

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

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

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

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

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

const Point &	a () const

const Point &	b () const

	Line (const Line &other)

	Line (Line &&)=default

Line &	operator= (const Line &line)

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

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 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 &	resize (double width, double height, LineWidthFlag lineWidthFlag)

Shape &	scaleToWidth (double w, LineWidthFlag lineWidthFlag)

Shape &	scaleToHeight (double h, LineWidthFlag lineWidthFlag)

Rect	bbox (LineWidthFlag) const

	Shape (const Shape &other)

Protected Attributes
Point	_a

Point	_b

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 line between two points.

The line structure.

Examples: examples/ellipse.cpp, examples/example4.cpp, examples/flag.cpp, examples/holes.cpp, examples/logo.cpp, examples/ruler.cpp, examples/stroke_path.cpp, examples/tilings.cpp, and examples/traversal.cpp.

Constructor & Destructor Documentation

◆ Line() [1/4]

LibBoard::Line::Line	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		Color	color,
		double	lineWidth = `Style::defaultLineWidth()`,
		const LineStyle	lineStyle = `Style::defaultLineStyle()`,
		const LineCap	cap = `Style::defaultLineCap()`,
		const LineJoin	join = `Style::defaultLineJoin()`
	)

inline

Constructs a line.

Parameters

x1	First coordinate of the start point.
y1	Second coordinate of the start point.
x2	First coordinate of the end point.
y2	Second coordinate of the end point.
color	The color of the line.
lineWidth	The line thickness.
lineStyle	The line style.
cap	The line cap.
join	The line join.

Referenced by clone(), resized(), and scaled().

◆ Line() [2/4]

LibBoard::Line::Line	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		const Style &	style
	)

inline

Constructs a line.

Parameters

x1	First coordinate of the start point.
y1	Second coordinate of the start point.
x2	First coordinate of the end point.
y2	Second coordinate of the end point.
style	The shape style.

◆ Line() [3/4]

LibBoard::Line::Line	(	Point	a,
		Point	b,
		Color	color,
		double	lineWidth = `Style::defaultLineWidth()`,
		const LineStyle	lineStyle = `Style::defaultLineStyle()`,
		const LineCap	cap = `Style::defaultLineCap()`,
		const LineJoin	join = `Style::defaultLineJoin()`
	)

inline

Constructs a line.

Parameters

a	First extremity.
b	Second extremity.
color	The color of the line.
lineWidth	The line thickness.
lineStyle	The line style.
cap	The line cap.
join	The line join.

◆ Line() [4/4]

LibBoard::Line::Line	(	Point	a,
		Point	b,
		const Style &	style
	)

inline

Constructs a line.

Parameters

a	First extremity.
b	Second extremity.
style	The shape style.

Member Function Documentation

◆ a()

const Point & LibBoard::Line::a ( ) const

inline

The first extremity of the line.

Returns: The first extremity of the line.

References _a.

Referenced by LibBoard::Arrow::flushFIG(), flushFIG(), flushPostscript(), flushSVG(), LibBoard::Arrow::flushTikZ(), and flushTikZ().

◆ accept() [1/6]

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

overridevirtual

Accept a composite shape transform.

Parameters

transform A composite shape transform object.

Reimplemented from LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

◆ accept() [2/6]

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

overridevirtual

Accept a constant composite shape transform.

Parameters

transform A constant composite shape transform object..

Reimplemented from LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

◆ accept() [3/6]

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

overridevirtual

Accepts a const-shape visitor object.

Parameters

visitor A const-shape visitor object.

Reimplemented from LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

◆ accept() [4/6]

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

overridevirtual

Accepts a visitor object.

Parameters

visitor A visitor object.

Reimplemented from LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

◆ accept() [5/6]

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

overridevirtual

Accepts a const-shape visitor object.

Parameters

visitor A const-shape visitor object.

Reimplemented from LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

◆ accept() [6/6]

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

overridevirtual

Accepts a visitor object.

Parameters

visitor A visitor object.

Reimplemented from LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

◆ b()

const Point & LibBoard::Line::b ( ) const

inline

The second extremity of the line.

Returns: The second extremity of the line.

References _b.

Referenced by LibBoard::Arrow::flushFIG(), flushFIG(), flushPostscript(), flushSVG(), LibBoard::Arrow::flushTikZ(), and flushTikZ().

◆ boundingBox()

Rect LibBoard::Line::boundingBox ( LineWidthFlag lineWidthFlag ) const

overridevirtual

Returns the bounding box of the line.

Returns: The rectangle of the bounding box.

Implements LibBoard::Shape.

Examples: examples/ruler.cpp.

References _a, and _b.

◆ clone()

Line * LibBoard::Line::clone ( ) const

overridevirtual

Return a copy of the shape.

Returns: A copy of the shape.

Implements LibBoard::ShapeWithStyle.

References Line().

◆ flushFIG()

void LibBoard::Line::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 _a, _b, a(), b(), LibBoard::Point::x, and LibBoard::Point::y.

◆ flushPostscript()

void LibBoard::Line::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 _a, _b, a(), b(), LibBoard::Style::postscriptProperties(), LibBoard::Point::x, and LibBoard::Point::y.

◆ flushSVG()

void LibBoard::Line::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 _a, _b, a(), b(), LibBoard::Style::svgProperties(), LibBoard::Point::x, and LibBoard::Point::y.

◆ flushTikZ()

void LibBoard::Line::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 _a, _b, a(), b(), LibBoard::Style::tikzProperties(), LibBoard::Point::x, and LibBoard::Point::y.

◆ name()

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

overridevirtual

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

Returns

Reimplemented from LibBoard::Shape.

◆ resized()

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

Returns a resized copy of the line.

Parameters

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

Returns: A resized copy of the line.

References Line().

◆ rotate() [1/2]

Line & LibBoard::Line::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]

Line & LibBoard::Line::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/flag.cpp.

References _a, _b, LibBoard::Shape::center(), and LibBoard::Point::rotated().

Referenced by rotate().

◆ rotated() [1/2]

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

Returns a copy of the line, rotated around its center.

Parameters

angle The angle of rotation.

Returns: A copy of the lines, rotated around its center by the given angle.

References _a, _b, LibBoard::Shape::center(), and LibBoard::Point::rotated().

◆ rotated() [2/2]

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

Returns a copy of the line, rotated around a given rotation center.

Parameters

angle	The rotation angle.
center	The center of rotation.

Returns: The rotated copy of the line.

Examples: examples/logo.cpp.

References _a, _b, LibBoard::Shape::center(), and LibBoard::Point::rotated().

◆ scale() [1/2]

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

overridevirtual

Scale the line, given a scaling factor.

Parameters

s	Scaling factor.

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

Implements LibBoard::Shape.

References scale().

◆ scale() [2/2]

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

overridevirtual

Scale the line, given two scaling factors.

Parameters

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

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

Implements LibBoard::Shape.

Examples: examples/stroke_path.cpp.

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

Referenced by scale().

◆ scaleAll()

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

overridevirtual

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

Parameters

s	The scaling factor.

Implements LibBoard::Shape.

References _a, _b, LibBoard::Point::x, and LibBoard::Point::y.

◆ scaled() [1/2]

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

Returns a scaled copy of the line.

Parameters

s	The scaling factor.

Returns: A scaled copy of the line.

References scaled().

◆ scaled() [2/2]

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

Returns a scaled copy of the line.

Parameters

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

Returns: A scaled copy of the line.

References Line().

Referenced by scaled().

◆ translate()

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

overridevirtual

Translate the line by a given offset.

Parameters

dx	The x offset.
dy	The y offset.

Returns: A reference to the line itself.

Implements LibBoard::Shape.

Examples: examples/ruler.cpp.

References _a, _b, and LibBoard::Point::translate().

Referenced by scale().

◆ translated()

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

Returns a translated copy of the line.

Parameters

dx	The shift along the x axis.
dy	The shift along the y axis.

Returns: A translated copy of the line.

References _a, _b, and LibBoard::Point::translate().

Member Data Documentation

◆ _a

Point LibBoard::Line::_a

protected

Start point.

Referenced by a(), LibBoard::Arrow::boundingBox(), boundingBox(), LibBoard::Arrow::flushFIG(), flushFIG(), LibBoard::Arrow::flushPostscript(), flushPostscript(), flushSVG(), LibBoard::Arrow::flushTikZ(), flushTikZ(), rotate(), rotated(), scale(), scaleAll(), translate(), and translated().

◆ _b

Point LibBoard::Line::_b

protected

End point.

Referenced by b(), boundingBox(), LibBoard::Arrow::flushFIG(), flushFIG(), flushPostscript(), flushSVG(), LibBoard::Arrow::flushTikZ(), flushTikZ(), rotate(), rotated(), scale(), scaleAll(), translate(), and translated().

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

include/board/Line.h
src/Line.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Line() [1/4]

◆ Line() [2/4]

◆ Line() [3/4]

◆ Line() [4/4]

Member Function Documentation

◆ a()

◆ accept() [1/6]

◆ accept() [2/6]

◆ accept() [3/6]

◆ accept() [4/6]

◆ accept() [5/6]

◆ accept() [6/6]

◆ b()

◆ boundingBox()

◆ clone()

◆ flushFIG()

◆ flushPostscript()

◆ flushSVG()

◆ flushTikZ()

◆ name()

◆ 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]

◆ translate()

◆ translated()

Member Data Documentation

◆ _a

◆ _b