A line between two points with an arrow at one extremity. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Arrow:

Public Member Functions
	Arrow (double x1, double y1, double x2, double y2, Color penColor, Color fillColor, double lineWidth, const LineStyle style=SolidStyle, const LineCap cap=ButtCap, const LineJoin join=MiterJoin, int depth=-1)

const std::string &	name () const

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

Arrow	rotated (double angle) const

Arrow	translated (double dx, double dy) const

Arrow	scaled (double sx, double sy) const

Arrow	scaled (double s) const

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

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

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

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

Arrow *	clone () const

Public Member Functions inherited from LibBoard::Line
	Line (double x1, double y1, double x2, double y2, Color color, double lineWidth, const LineStyle style=SolidStyle, const LineCap cap=ButtCap, const LineJoin join=MiterJoin, int depth=-1)

Point	center () const

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

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

Line &	rotate (double angle)

Line	rotated (double angle) const

Line &	translate (double dx, double dy)

Line	translated (double dx, double dy) const

Line &	scale (double sx, double sy)

Line &	scale (double s)

Line	scaled (double sx, double sy) const

Line	scaled (double s) const

void	scaleAll (double s)

Rect	boundingBox () 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

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

Shape &	rotateDeg (double angle)

Shape &	moveCenter (double x, double y)

Shape &	moveCenter (Point p)

Rect	bbox () 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

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 }

Protected Member Functions inherited from LibBoard::Shape
std::string	svgProperties (const TransformSVG &transform) const

std::string	postscriptProperties () const

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

Protected Attributes inherited from LibBoard::Line
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

Detailed Description

A line between two points with an arrow at one extremity.

The arrow structure.

Examples:: examples/graph.cpp.

Constructor & Destructor Documentation

LibBoard::Arrow::Arrow	(	double	x1,
		double	y1,
		double	x2,
		double	y2,
		Color	penColor,
		Color	fillColor,
		double	lineWidth,
		const LineStyle	style = `SolidStyle`,
		const LineCap	cap = `ButtCap`,
		const LineJoin	join = `MiterJoin`,
		int	depth = `-1`
	)

inline

Constructs an arrow.

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.
penColor	The color of the line.
fillColor	The fill color of the sharp end.
lineWidth	The line thickness.
depth	The depth of the line.

Referenced by clone().

Member Function Documentation

Arrow * LibBoard::Arrow::clone ( ) const

virtual

Return a copy of the shape.

Returns: A copy of the shape.

Reimplemented from LibBoard::Line.

References Arrow().

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

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.

Reimplemented from LibBoard::Line.

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

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

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.

Reimplemented from LibBoard::Line.

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

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

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.

Reimplemented from LibBoard::Line.

References LibBoard::Shape::_fillColor, LibBoard::Shape::_lineStyle, LibBoard::Shape::_lineWidth, LibBoard::Shape::_penColor, LibBoard::Line::_x1, LibBoard::Line::_x2, LibBoard::Line::_y1, LibBoard::Line::_y2, and LibBoard::Color::svgAlpha().

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

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.

Reimplemented from LibBoard::Line.

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

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

virtual

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

Returns

Reimplemented from LibBoard::Line.

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

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

Parameters

angle	The rotation angle.
center	The center of rotation.

Returns: The rotated copy of the line.

References LibBoard::Line::_x1, LibBoard::Line::_x2, LibBoard::Line::_y1, LibBoard::Line::_y2, LibBoard::Point::get(), and LibBoard::Point::rotate().

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

Returns a copy of the arrow, 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 LibBoard::Line::_x1, LibBoard::Line::_x2, LibBoard::Line::_y1, LibBoard::Line::_y2, LibBoard::Line::center(), LibBoard::Point::get(), and LibBoard::Point::rotate().

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

Returns a scaled copy of the arrow.

Parameters

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

Returns: A scaled copy of the arrow.

References LibBoard::Line::_x1, LibBoard::Line::_x2, LibBoard::Line::_y1, LibBoard::Line::_y2, LibBoard::Line::center(), LibBoard::Line::translate(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by scaled().

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

Returns a scaled copy of the arrow.

Parameters

s	The scaling factor.

Returns: A scaled copy of the arrow.

References scaled().

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

Returns a translated copy of the arrow.

Parameters

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

Returns: A translated copy of the line.

Examples:: examples/graph.cpp.

References LibBoard::Line::_x1, LibBoard::Line::_x2, LibBoard::Line::_y1, and LibBoard::Line::_y2.

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation