A line between two points. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Line:

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

	Line (Point a, Point b, Color color, 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

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

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

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
double	_x1

double	_y1

double	_x2

double	_y2

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

The line structure.

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

Constructor & Destructor Documentation

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

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.
depth	The depth of the line.

Referenced by clone(), and scaled().

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

inline

Constructs a line.

Parameters

a	First extremity.
b	Second extremity.
color	The color of the line.
lineWidth	The line thickness.
depth	The depth of the line.

Member Function Documentation

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.

Reimplemented in LibBoard::Arrow.

Examples:: examples/ruler.cpp.

References LibBoard::Shape::_lineCap, LibBoard::Shape::_lineJoin, LibBoard::Shape::_lineWidth, _x1, _x2, _y1, _y2, and LibBoard::Path::boundingBox().

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

overridevirtual

Return a copy of the shape.

Returns: A copy of the shape.

Implements LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

References Line().

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.

Implements LibBoard::Shape.

Reimplemented in LibBoard::Arrow.

References LibBoard::Shape::_depth, LibBoard::Shape::_lineCap, LibBoard::Shape::_lineJoin, LibBoard::Shape::_lineStyle, LibBoard::Shape::_lineWidth, LibBoard::Shape::_penColor, _x1, _x2, _y1, and _y2.

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.

Reimplemented in LibBoard::Arrow.

References LibBoard::Shape::_penColor, _x1, _x2, _y1, _y2, and LibBoard::Shape::postscriptProperties().

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.

Reimplemented in LibBoard::Arrow.

References _x1, _x2, _y1, _y2, and LibBoard::Shape::svgProperties().

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.

Reimplemented in LibBoard::Arrow.

References _x1, _x2, _y1, _y2, and LibBoard::Shape::tikzProperties().

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.

Reimplemented in LibBoard::Arrow.

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 _x1, _x2, _y1, _y2, LibBoard::Point::get(), and LibBoard::Point::rotate().

Referenced by rotate().

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

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 _x1, _x2, _y1, _y2, LibBoard::Point::get(), and LibBoard::Point::rotate().

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 _x1, _x2, _y1, _y2, LibBoard::Shape::center(), LibBoard::Point::get(), and LibBoard::Point::rotate().

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 _x1, _x2, _y1, _y2, LibBoard::Shape::center(), translate(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by scale().

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

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 _x1, _x2, _y1, and _y2.

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

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

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 _x1, _x2, _y1, and _y2.

Referenced by LibBoard::Board::makeGrid(), and scale().

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 _x1, _x2, _y1, and _y2.

Member Data Documentation

double LibBoard::Line::_x1

protected

First coordinate of the start point.

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

double LibBoard::Line::_x2

protected

First coordinate of the end point.

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

double LibBoard::Line::_y1

protected

Second coordinate of the start point.

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

double LibBoard::Line::_y2

protected

Second coordinate of the end point.

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

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation