A rectangle. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Rectangle:

Public Member Functions
	Rectangle (double left, double top, double width, double height, Color penColor, Color fillColor, double lineWidth, const LineStyle style=SolidStyle, const LineCap cap=ButtCap, const LineJoin join=MiterJoin, int depth=-1)

	Rectangle (const Rect &rect, 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

double	x () const

double	y () const

double	width () const

double	height () const

Point	topLeft () const

Point	topRight () const

Point	bottomLeft () const

Point	bottomRight () const

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

Rectangle	rotated (double angle) const

Rectangle	translated (double dx, double dy) const

Rectangle	scaled (double sx, double sy) const

Rectangle	scaled (double s) const

void	scaleAll (double s)

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

Rectangle *	clone () const

Public Member Functions inherited from LibBoard::Polyline
	Polyline (const std::vector< Point > &points, bool closed, Color penColor, Color fillColor, double lineWidth, const LineStyle lineStyle=SolidStyle, const LineCap cap=ButtCap, const LineJoin join=MiterJoin, int depth=-1)

	Polyline (const Path &path, Color penColor, Color fillColor, double lineWidth, const LineStyle lineStyle=SolidStyle, const LineCap cap=ButtCap, const LineJoin join=MiterJoin, int depth=-1)

	Polyline (bool closed, Color penColor, Color fillColor, double lineWidth, const LineStyle lineStyle=SolidStyle, const LineCap cap=ButtCap, const LineJoin join=MiterJoin, int depth=-1)

Point	center () const

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)

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

Polyline &	rotate (double angle)

Polyline	rotated (double angle) const

Polyline &	translate (double dx, double dy)

Polyline	translated (double dx, double dy) const

Polyline &	scale (double sx, double sy)

Polyline &	scale (double s)

Polyline	scaled (double sx, double sy) const

Polyline	scaled (double s) const

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

Rect	boundingBox () const

std::size_t	vertexCount () 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

Protected Attributes
bool	_isRectangle

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

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

Detailed Description

A rectangle.

The rectangle structure.

Examples:: examples/arrows.cpp, examples/ellipse.cpp, examples/example4.cpp, examples/line_style.cpp, examples/ruler.cpp, and examples/scale_ellipse.cpp.

Member Function Documentation

Rectangle * LibBoard::Rectangle::clone ( ) const

virtual

Return a copy of the shape.

Returns: A copy of the shape.

Reimplemented from LibBoard::Polyline.

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

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

Referenced by LibBoard::Image::flushFIG(), and LibBoard::Board::saveFIG().

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

References LibBoard::Polyline::flushSVG(), LibBoard::Point::norm(), and LibBoard::Shape::svgProperties().

Referenced by LibBoard::Board::saveSVG().

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

References LibBoard::Polyline::flushTikZ().

Referenced by LibBoard::Image::flushTikZ(), and LibBoard::Board::saveTikZ().

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

virtual

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

Returns

Reimplemented from LibBoard::Polyline.

Rectangle LibBoard::Rectangle::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.

Examples:: examples/example4.cpp.

References LibBoard::Polyline::rotate().

Rectangle LibBoard::Rectangle::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::Polyline::center(), and LibBoard::Polyline::rotate().

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

virtual

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

Parameters

s	The scaling factor.

Reimplemented from LibBoard::Polyline.

References LibBoard::Path::scaleAll().

Referenced by LibBoard::Image::scaleAll().

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

Returns a scaled copy of the rectangle.

Parameters

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

Returns: A scaled copy of the rectangle.

References LibBoard::Polyline::scale().

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

Returns a scaled copy of the rectangle.

Parameters

s	The scaling factor.

Returns: A scaled copy of the rectangle.

References LibBoard::Polyline::scale().

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

Returns a translated copy of the rectangle.

Parameters

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

Returns: A translated copy of the rectangle.

Examples:: examples/example4.cpp.

References LibBoard::Polyline::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