An ellipse. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Ellipse:

Public Member Functions
	Ellipse (double x, double y, double xRadius, double yRadius, Color penColor=Shape::defaultPenColor(), Color fillColor=Shape::defaultFillColor(), double lineWidth=Shape::defaultLineWidth(), const LineStyle lineStyle=Shape::defaultLineStyle(), int depth=-1)

	Ellipse (Point center, double xRadius, double yRadius, Color penColor=Shape::defaultPenColor(), Color fillColor=Shape::defaultFillColor(), double lineWidth=Shape::defaultLineWidth(), const LineStyle lineStyle=Shape::defaultLineStyle(), int depth=-1)

const std::string &	name () const override

Point	center (LineWidthFlag lineWidthFlag=IgnoreLineWidth) const override

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

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

Ellipse &	rotate (double angle) override

Ellipse	rotated (double angle) const

Ellipse &	translate (double dx, double dy) override

Ellipse	translated (double dx, double dy) const

Ellipse &	scale (double sx, double sy) override

Ellipse &	scale (double s) override

Ellipse	scaled (double sx, double sy) const

Ellipse	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

Ellipse *	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
Point	_center

double	_xRadius

double	_yRadius

double	_angle

bool	_circle

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

An ellipse.

The ellipse structure.

Examples:: examples/ellipse.cpp, examples/example4.cpp, and examples/scale_ellipse.cpp.

Member Function Documentation

Rect LibBoard::Ellipse::boundingBox ( LineWidthFlag ) const

overridevirtual

Compute the bounding box of the figure.

Returns: The rectangle of the bounding box.

Implements LibBoard::Shape.

References LibBoard::Shape::_lineWidth, LibBoard::Point::x, and LibBoard::Point::y.

Point LibBoard::Ellipse::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.

Reimplemented in LibBoard::Circle.

Referenced by rotate(), and rotated().

Ellipse * LibBoard::Ellipse::clone ( ) const

overridevirtual

Return a copy of the shape.

Returns: A copy of the shape.

Implements LibBoard::Shape.

Reimplemented in LibBoard::Circle.

void LibBoard::Ellipse::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::_fillColor, LibBoard::Shape::_lineStyle, LibBoard::Shape::_lineWidth, LibBoard::Shape::_penColor, LibBoard::Shape::filled(), LibBoard::Point::x, and LibBoard::Point::y.

void LibBoard::Ellipse::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::_fillColor, LibBoard::Shape::_penColor, LibBoard::Shape::filled(), LibBoard::Shape::postscriptProperties(), LibBoard::Point::x, and LibBoard::Point::y.

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

References LibBoard::Shape::svgProperties(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by LibBoard::Circle::flushSVG().

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

References LibBoard::Shape::tikzProperties(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by LibBoard::Circle::flushTikZ().

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

overridevirtual

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

Returns

Reimplemented from LibBoard::Shape.

Reimplemented in LibBoard::Circle.

Ellipse & LibBoard::Ellipse::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.

Reimplemented in LibBoard::Circle.

References LibBoard::Point::rotated(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by rotate(), LibBoard::Circle::rotate(), and rotated().

Ellipse & LibBoard::Ellipse::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.

Reimplemented in LibBoard::Circle.

References center(), and rotate().

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

Parameters

angle
center

Returns

References rotate().

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

Parameters

angle

Returns

References center(), and rotate().

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

overridevirtual

Scale the polyline, given two scaling factors.

Parameters

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

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

Implements LibBoard::Shape.

Reimplemented in LibBoard::Circle.

Referenced by scale(), LibBoard::Circle::scale(), and scaled().

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

overridevirtual

Scale the ellipse, given a scaling factor.

Parameters

s	Scaling factor.

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

Implements LibBoard::Shape.

Reimplemented in LibBoard::Circle.

References scale().

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

overridevirtual

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

Parameters

s	The scaling factor.

Implements LibBoard::Shape.

Reimplemented in LibBoard::Circle.

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

Returns a scaled copy of the ellipse.

Parameters

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

Returns: A scaled copy of the ellipse.

References scale().

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

Returns a scaled copy of the ellipse.

Parameters

s	The scaling factor.

Returns: A scaled copy of the ellipse.

References scale().

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

overridevirtual

Translate the ellipse by a given offset.

Parameters

dx	The x offset.
dy	The y offset.

Returns: A reference to the ellipse itself.

Implements LibBoard::Shape.

Reimplemented in LibBoard::Circle.

Referenced by translated().

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

Returns a translated copy of the ellipse.

Parameters

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

Returns: A copy of the ellipse, translated.

References 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