A line between two points. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Dot:

Public Member Functions
	Dot (double x, double y, Color color, double lineWidth=Shape::defaultLineWidth(), int depth=-1)

const std::string &	name () const override

Point	center (LineWidthFlag flage=IgnoreLineWidth) const override

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

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

Dot &	rotate (double angle) override

Dot	rotated (double angle) const

Dot &	translate (double dx, double dy) override

Dot	translated (double dx, double dy) const

Dot &	scale (double sx, double sy) override

Dot &	scale (double s) override

Dot	scaled (double sx, double sy) const

Dot	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

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

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	_x

double	_y

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 dot structure. This primitive ha been reported as "missing" by Manuel Peinado from Spain. Manuel also suggested that rendering a dot consists in drawing a line from a point to the same point with a roundcap style.

Examples:: examples/example4.cpp.

Member Function Documentation

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

overridevirtual

Returns the bounding box of the dot.

Returns: The rectangle of the bounding box.

Implements LibBoard::Shape.

References LibBoard::Shape::_lineWidth, _x, and _y.

Point LibBoard::Dot::center ( LineWidthFlag lineWidthFlag = IgnoreLineWidth ) const

overridevirtual

Returns the center of the shape.

Parameters

lineWidthFlag Should the line width be considered when computing bounding boxes.

Returns: The center of the shape, i.e. the center of its bounding box.

Reimplemented from LibBoard::Shape.

References _x, and _y.

Dot * LibBoard::Dot::clone ( ) const

overridevirtual

Return a copy of the shape.

Returns: A copy of the shape.

Implements LibBoard::Shape.

void LibBoard::Dot::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.

References LibBoard::Shape::_depth, LibBoard::Shape::_lineCap, LibBoard::Shape::_lineJoin, LibBoard::Shape::_lineWidth, LibBoard::Shape::_penColor, _x, and _y.

void LibBoard::Dot::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 LibBoard::Shape::_penColor, _x, _y, and LibBoard::Shape::postscriptProperties().

void LibBoard::Dot::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 _x, _y, and LibBoard::Shape::svgProperties().

void LibBoard::Dot::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.

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

overridevirtual

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

Returns

Reimplemented from LibBoard::Shape.

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

overridevirtual

Rotates the dot around a given center of rotation.

Parameters

angle	The rotation angle.
center	The center of rotation.

Returns: A reference to the Dot itself.

Implements LibBoard::Shape.

References _x, _y, LibBoard::Point::get(), and LibBoard::Point::rotate().

Referenced by rotated().

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

overridevirtual

Rotates the dot around its center (actually does nothing!).

Parameters

angle The rotation angle.

Returns: A reference to the Dot itself.

Implements LibBoard::Shape.

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

Returns a rotated copy of the dot around a given rotation center.

Parameters

angle	Th rotation angle.
center	The center of rotation.

Returns: A rotated copy of the Dot.

References rotate().

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

Returns a copy of the dot rotated around its center (i.e. left unchanged!)

Parameters

angle The rotation angle.

Returns: A copy of the dot.

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

overridevirtual

Scale the dot, given two scaling factors.

Parameters

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

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

Implements LibBoard::Shape.

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

overridevirtual

Scale the dot, given a scaling factor.

Parameters

s	Scaling factor.

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

Implements LibBoard::Shape.

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

overridevirtual

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

Parameters

s	The scaling factor.

Implements LibBoard::Shape.

References _x, and _y.

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

Returns a scaled copy of the dot, i.e. the dot itself. (Dots are not actually scaled since their diameters is given by the line width.)

Parameters

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

Returns: A scaled copy of the Dot, i.e. the Dot itself.

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

Returns a scaled copy of the dot, i.e. the dot itself. (Dots are not actually scaled since their diameters is given by the line width.)

Parameters

s	The scaling factor.

Returns: A scaled copy of the Dot, i.e. the Dot itself.

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

overridevirtual

Translate the dot by a given offset.

Parameters

dx	The x offset.
dy	The y offset.

Returns: A reference to the dot itself.

Implements LibBoard::Shape.

References _x, and _y.

Referenced by translated().

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

Returns a translated copy of the dot.

Parameters

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

Returns: A copy of the dot, translated.

References translate().

Member Data Documentation

double LibBoard::Dot::_x

protected

First coordinate of the dot.

Referenced by boundingBox(), center(), flushFIG(), flushPostscript(), flushSVG(), rotate(), scaleAll(), and translate().

double LibBoard::Dot::_y

protected

Second coordinate of the dot.

Referenced by boundingBox(), center(), flushFIG(), flushPostscript(), flushSVG(), rotate(), scaleAll(), and 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

Member Data Documentation