LibBoard::Circle Struct Reference

A circle. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Circle:

LibBoard::Ellipse LibBoard::Shape

List of all members.

Public Member Functions

 Circle (double x, double y, double radius, Color penColor, Color fillColor, float lineWidth, int depth=-1)
const std::string & name () const
Point center () const
Shaperotate (double angle, const Point &center)
Circle rotated (double angle, const Point &center) const
Shaperotate (double angle)
Circle rotated (double angle) const
Shapetranslate (double dx, double dy)
Circle translated (double dx, double dy) const
Shapescale (double sx, double sy)
Shapescale (double s)
Circle scaled (double sx, double sy) const
Circle scaled (double s) const
void scaleAll (double s)
void flushSVG (std::ostream &stream, const TransformSVG &transform) const
Shapeclone () const


Detailed Description

A circle.

The circle structure.

Examples:

examples/example4.cpp, and examples/graph.cpp.


Member Function Documentation

const std::string & LibBoard::Circle::name (  )  const [virtual]

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

Returns:

Reimplemented from LibBoard::Ellipse.

Point LibBoard::Circle::center (  )  const [virtual]

Returns the gravity center of the shape.

Returns:
The center of the shape.

Reimplemented from LibBoard::Ellipse.

Shape & LibBoard::Circle::rotate ( double  angle,
const Point center 
) [virtual]

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.

Reimplemented from LibBoard::Ellipse.

References LibBoard::Ellipse::rotate(), and LibBoard::Point::rotate().

Referenced by rotated().

Circle LibBoard::Circle::rotated ( double  angle,
const Point center 
) const

Parameters:
angle 
center 
Returns:

Reimplemented from LibBoard::Ellipse.

References rotate().

Shape & LibBoard::Circle::rotate ( double  angle  )  [virtual]

Rotate the shape around its center.

Parameters:
angle The rotation angle in radian.
Returns:
A reference to the shape itself.

Reimplemented from LibBoard::Ellipse.

References LibBoard::Ellipse::rotate().

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

Parameters:
angle 
Returns:

Reimplemented from LibBoard::Ellipse.

References rotate().

Shape & LibBoard::Circle::translate ( double  dx,
double  dy 
) [virtual]

Translate the shape by a given offset.

Parameters:
dx The x offset.
dy The y offset.
Returns:
A reference to the shape itself.

Reimplemented from LibBoard::Ellipse.

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

Parameters:
dx 
dy 
Returns:

Reimplemented from LibBoard::Ellipse.

References LibBoard::Ellipse::_center, LibBoard::Point::x, and LibBoard::Point::y.

Shape & LibBoard::Circle::scale ( double  sx,
double  sy 
) [virtual]

Scale the shape along the x an y axis.

Parameters:
sx The scale factor along the x axis.
sy The scale factor along the y axis.
Returns:
The shape itself.

Reimplemented from LibBoard::Ellipse.

Examples:
examples/example4.cpp.

References LibBoard::Ellipse::scale().

Referenced by scaled().

Shape & LibBoard::Circle::scale ( double  s  )  [virtual]

Scale the shape along both axis.

Parameters:
s The scale factor along both axis.
Returns:
The shape itself.

Reimplemented from LibBoard::Ellipse.

References LibBoard::Ellipse::scale().

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

Parameters:
sx 
sy 
Returns:

Reimplemented from LibBoard::Ellipse.

References scale().

void LibBoard::Circle::scaleAll ( double  s  )  [virtual]

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

Parameters:
s The scaling factor.

Reimplemented from LibBoard::Ellipse.

void LibBoard::Circle::flushSVG ( std::ostream &  stream,
const TransformSVG transform 
) const [virtual]

Writes 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::Ellipse.

References LibBoard::Ellipse::flushSVG(), LibBoard::Transform::mapX(), LibBoard::TransformSVG::mapY(), LibBoard::Transform::scale(), LibBoard::Shape::svgProperties(), LibBoard::Point::x, and LibBoard::Point::y.

Shape * LibBoard::Circle::clone (  )  const [virtual]

Return a copy of the shape.

Returns:

Reimplemented from LibBoard::Ellipse.


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

Generated on Mon Jan 19 09:48:19 2009 for Board by  doxygen 1.5.6