Board  0.9.4
Public Member Functions | List of all members
LibBoard::Circle Struct Reference

A circle. More...

#include <Shapes.h>

Inheritance diagram for LibBoard::Circle:
LibBoard::Ellipse LibBoard::Shape

Public Member Functions

 Circle (double x, double y, double radius, Color penColor=Shape::defaultPenColor(), Color fillColor=Shape::defaultFillColor(), double lineWidth=Shape::defaultLineWidth(), const LineStyle lineStyle=Shape::defaultLineStyle(), int depth=-1)
 
 Circle (Point center, double radius, 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
 
Circlerotate (double angle, const Point &center) override
 
Circle rotated (double angle, const Point &center) const
 
Circlerotate (double angle) override
 
Circle rotated (double angle) const
 
Circletranslate (double dx, double dy) override
 
Circle translated (double dx, double dy) const
 
Circlescale (double sx, double sy) override
 
Circlescale (double s) override
 
Circle scaled (double sx, double sy) const
 
Circle scaled (double s) const
 
void scaleAll (double s) override
 
void flushSVG (std::ostream &stream, const TransformSVG &transform) const override
 
void flushTikZ (std::ostream &stream, const TransformTikZ &transform) const override
 
Circleclone () const override
 
- Public Member Functions inherited from LibBoard::Ellipse
 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)
 
Ellipse rotated (double angle, const Point &center) const
 
Ellipse rotated (double angle) const
 
Ellipse translated (double dx, double dy) const
 
Ellipse scaled (double sx, double sy) const
 
Ellipse scaled (double s) const
 
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
 
Rect boundingBox (LineWidthFlag) 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
 
ShaperotateDeg (double angle, const Point &center)
 
ShaperotateDeg (double angle)
 
ShapemoveCenter (double x, double y, LineWidthFlag lineWidthFlag=IgnoreLineWidth)
 
ShapemoveCenter (Point p, LineWidthFlag lineWidthFlag=IgnoreLineWidth)
 
ShapescaleToWidth (double w, LineWidthFlag lineWidthFlag)
 
ShapescaleToHeight (double h, LineWidthFlag lineWidthFlag)
 
Rect bbox (LineWidthFlag) const
 
Shapeoperator-- ()
 
Shapeoperator++ ()
 
int depth () const
 
virtual void depth (int)
 
virtual void shiftDepth (int shift)
 
const ColorpenColor () const
 
const ColorfillColor () const
 
virtual void accept (ShapeVisitor &visitor)
 Accepts a visitor object. More...
 
virtual void accept (const ShapeVisitor &visitor)
 Accepts a visitor object. More...
 

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
 
- Protected Attributes inherited from LibBoard::Ellipse
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
 
- 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 circle.

The circle structure.

Examples:
examples/clipping.cpp, examples/example4.cpp, examples/flag.cpp, examples/graph.cpp, examples/stroke_path.cpp, and examples/tilings.cpp.

Member Function Documentation

Point LibBoard::Circle::center ( LineWidthFlag  lineWidthFlag = IgnoreLineWidth) const
overridevirtual

Returns the center of the shape.

Parameters
lineWidthFlagShould 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::Ellipse.

Circle * LibBoard::Circle::clone ( ) const
overridevirtual

Return a copy of the shape.

Returns
A copy of the shape.

Reimplemented from LibBoard::Ellipse.

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

Write the SVG code of the shape in a stream according to a transform.

Parameters
streamThe output stream.
transformA 2D transform to be applied.

Reimplemented from LibBoard::Ellipse.

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

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

Write the TikZ code of the shape in a stream according to a transform.

Parameters
streamThe output stream.
transformA 2D transform to be applied.

Reimplemented from LibBoard::Ellipse.

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

const std::string & LibBoard::Circle::name ( ) const
overridevirtual

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

Returns

Reimplemented from LibBoard::Ellipse.

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

Rotate the shape around a given center of rotation.

Parameters
angleThe rotation angle in radian.
centerThe center of rotation.
Returns
A reference to the shape itself.

Reimplemented from LibBoard::Ellipse.

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

Circle & LibBoard::Circle::rotate ( double  angle)
overridevirtual

Rotate the shape around its center.

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

Reimplemented from LibBoard::Ellipse.

References LibBoard::Ellipse::rotate().

Circle & LibBoard::Circle::scale ( double  sx,
double  sy 
)
overridevirtual

Scale the circle, given two scaling factors.

Parameters
sxScaling factor along the x axis.
syScaling factor along the y axis.
Returns
A reference to the circle itself, once scaled.

Reimplemented from LibBoard::Ellipse.

Examples:
examples/example4.cpp.

References LibBoard::Ellipse::scale().

Referenced by scaled().

Circle & LibBoard::Circle::scale ( double  s)
overridevirtual

Scale the circle, given a scaling factor.

Parameters
sScaling factor.
Returns
A reference to the circle itself, once scaled.

Reimplemented from LibBoard::Ellipse.

References LibBoard::Ellipse::scale().

void LibBoard::Circle::scaleAll ( double  s)
overridevirtual

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

Parameters
sThe scaling factor.

Reimplemented from LibBoard::Ellipse.

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

Returns a scaled copy of the circle.

Parameters
sxThe scaling factor along the x axis.
syThe scaling factor along the y axis.
Returns
A scaled copy of the circle.

References scale().

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

Returns a scaled copy of the circle.

Parameters
sThe scaling factor.
Returns
A scaled copy of the circle.

References scale().

Circle & LibBoard::Circle::translate ( double  dx,
double  dy 
)
overridevirtual

Translate the circle by a given offset.

Parameters
dxThe x offset.
dyThe y offset.
Returns
A reference to the circle itself.

Reimplemented from LibBoard::Ellipse.

Referenced by translated().

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

Returns a translated copy of the circle.

Parameters
dxShift of the first coordinate.
dyShift of the second coordinate.
Returns
A copy of the circle, translated.

References translate().


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