DGtal  1.5.beta
Public Member Functions | Data Fields
LibBoard::Board::State Struct Reference

#include <Board/Board.h>

Public Member Functions

 State ()
 
double unit (const double &x)
 
Point unit (const Point &p)
 
void unit (Shape &shape)
 

Data Fields

DGtal::Color penColor
 
DGtal::Color fillColor
 
double lineWidth
 
Shape::LineStyle lineStyle
 
Shape::LineCap lineCap
 
Shape::LineJoin lineJoin
 
Fonts::Font font
 
double fontSize
 
double unitFactor
 

Detailed Description

Current graphical state for drawings made by the drawSomething() methods.

Definition at line 940 of file Board.h.

Constructor & Destructor Documentation

◆ State()

LibBoard::Board::State::State ( )

Definition at line 90 of file Board.cpp.

91 {
92  penColor = DGtal::Color::Black;
93  fillColor = DGtal::Color::None;
94  lineWidth = 0.5;
95  lineStyle = Shape::SolidStyle;
96  lineCap = Shape::ButtCap;
97  lineJoin = Shape::MiterJoin;
98  font = Fonts::TimesRoman;
99  fontSize = 11.0;
100  unitFactor = 1.0;
101 }
DGtal::Color::None
static const Color None
Definition: Color.h:412
DGtal::Color::Black
static const Color Black
Definition: Color.h:413
LibBoard::Board::State::penColor
DGtal::Color penColor
Definition: Board.h:941
LibBoard::Board::State::lineJoin
Shape::LineJoin lineJoin
Definition: Board.h:946
LibBoard::Board::State::lineCap
Shape::LineCap lineCap
Definition: Board.h:945
LibBoard::Board::State::font
Fonts::Font font
Definition: Board.h:947
LibBoard::Board::State::lineStyle
Shape::LineStyle lineStyle
Definition: Board.h:944
LibBoard::Board::State::fillColor
DGtal::Color fillColor
Definition: Board.h:942

References DGtal::Color::Black, LibBoard::Shape::ButtCap, fillColor, font, fontSize, lineCap, lineJoin, lineStyle, lineWidth, LibBoard::Shape::MiterJoin, DGtal::Color::None, penColor, LibBoard::Shape::SolidStyle, LibBoard::Fonts::TimesRoman, and unitFactor.

Member Function Documentation

◆ unit() [1/3]

double LibBoard::Board::State::unit ( const double &  x)
inline

Definition at line 951 of file Board.h.

951 { return x * unitFactor; }

References unitFactor.

Referenced by LibBoard::Board::drawArc(), LibBoard::Board::drawArrow(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawCircle(), LibBoard::Board::drawClosedPolyline(), LibBoard::Board::drawDot(), LibBoard::Board::drawEllipse(), LibBoard::Board::drawImage(), LibBoard::Board::drawLine(), LibBoard::Board::drawPolyline(), LibBoard::Board::drawQuadraticBezierCurve(), LibBoard::Board::drawRectangle(), LibBoard::Board::drawText(), LibBoard::Board::drawTriangle(), LibBoard::Board::fillCircle(), LibBoard::Board::fillEllipse(), LibBoard::Board::fillGouraudTriangle(), LibBoard::Board::fillPolyline(), LibBoard::Board::fillRectangle(), LibBoard::Board::fillTriangle(), LibBoard::Board::setClippingPath(), and LibBoard::Board::setClippingRectangle().

◆ unit() [2/3]

Point LibBoard::Board::State::unit ( const Point &  p)
inline

Definition at line 952 of file Board.h.

952 { return Point( p.x * unitFactor, p.y * unitFactor); }
Point
MyPointD Point
Definition: testClone2.cpp:383

References unitFactor.

◆ unit() [3/3]

void LibBoard::Board::State::unit ( Shape &  shape)
inline

Definition at line 953 of file Board.h.

953 { shape.scaleAll( unitFactor ); }

References LibBoard::Shape::scaleAll(), and unitFactor.

Field Documentation

◆ fillColor

DGtal::Color LibBoard::Board::State::fillColor

The fill color.

Definition at line 942 of file Board.h.

Referenced by LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawCircle(), LibBoard::Board::drawClosedPolyline(), LibBoard::Board::drawEllipse(), LibBoard::Board::drawPolyline(), LibBoard::Board::drawQuadraticBezierCurve(), LibBoard::Board::drawRectangle(), LibBoard::Board::drawTriangle(), LibBoard::Board::setFillColor(), LibBoard::Board::setFillColorRGBf(), LibBoard::Board::setFillColorRGBi(), and State().

◆ font

Fonts::Font LibBoard::Board::State::font

The font.

Definition at line 947 of file Board.h.

Referenced by LibBoard::Board::drawText(), LibBoard::Board::setFont(), and State().

◆ fontSize

double LibBoard::Board::State::fontSize

The font size.

Definition at line 948 of file Board.h.

Referenced by LibBoard::Board::drawText(), LibBoard::Board::setFont(), LibBoard::Board::setFontSize(), and State().

◆ lineCap

Shape::LineCap LibBoard::Board::State::lineCap

The type of line extremities.

Definition at line 945 of file Board.h.

Referenced by LibBoard::Board::drawArrow(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawClosedPolyline(), LibBoard::Board::drawLine(), LibBoard::Board::drawPolyline(), LibBoard::Board::drawQuadraticBezierCurve(), LibBoard::Board::drawRectangle(), LibBoard::Board::drawTriangle(), LibBoard::Board::fillPolyline(), LibBoard::Board::fillRectangle(), LibBoard::Board::fillTriangle(), and State().

◆ lineJoin

Shape::LineJoin LibBoard::Board::State::lineJoin

The type of line junction.

Definition at line 946 of file Board.h.

Referenced by LibBoard::Board::drawArrow(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawClosedPolyline(), LibBoard::Board::drawLine(), LibBoard::Board::drawPolyline(), LibBoard::Board::drawQuadraticBezierCurve(), LibBoard::Board::drawRectangle(), LibBoard::Board::drawTriangle(), LibBoard::Board::fillPolyline(), LibBoard::Board::fillRectangle(), LibBoard::Board::fillTriangle(), and State().

◆ lineStyle

Shape::LineStyle LibBoard::Board::State::lineStyle

The line style.

Definition at line 944 of file Board.h.

Referenced by LibBoard::Board::drawArc(), LibBoard::Board::drawArrow(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawCircle(), LibBoard::Board::drawClosedPolyline(), LibBoard::Board::drawEllipse(), LibBoard::Board::drawLine(), LibBoard::Board::drawPolyline(), LibBoard::Board::drawQuadraticBezierCurve(), LibBoard::Board::drawRectangle(), LibBoard::Board::drawTriangle(), LibBoard::Board::fillCircle(), LibBoard::Board::fillEllipse(), LibBoard::Board::fillPolyline(), LibBoard::Board::fillRectangle(), LibBoard::Board::fillTriangle(), and State().

◆ lineWidth

double LibBoard::Board::State::lineWidth

The line thickness.

Definition at line 943 of file Board.h.

Referenced by LibBoard::Board::drawArc(), LibBoard::Board::drawArrow(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawCircle(), LibBoard::Board::drawClosedPolyline(), LibBoard::Board::drawDot(), LibBoard::Board::drawEllipse(), LibBoard::Board::drawLine(), LibBoard::Board::drawPolyline(), LibBoard::Board::drawQuadraticBezierCurve(), LibBoard::Board::drawRectangle(), LibBoard::Board::drawTriangle(), LibBoard::Board::setLineWidth(), and State().

◆ penColor

DGtal::Color LibBoard::Board::State::penColor

The pen color.

Definition at line 941 of file Board.h.

Referenced by LibBoard::Board::drawArc(), LibBoard::Board::drawArrow(), LibBoard::Board::drawBoundingBox(), LibBoard::Board::drawCircle(), LibBoard::Board::drawClosedPolyline(), LibBoard::Board::drawDot(), LibBoard::Board::drawEllipse(), LibBoard::Board::drawLine(), LibBoard::Board::drawPolyline(), LibBoard::Board::drawQuadraticBezierCurve(), LibBoard::Board::drawRectangle(), LibBoard::Board::drawText(), LibBoard::Board::drawTriangle(), LibBoard::Board::fillCircle(), LibBoard::Board::fillEllipse(), LibBoard::Board::fillGouraudTriangle(), LibBoard::Board::fillPolyline(), LibBoard::Board::fillRectangle(), LibBoard::Board::fillTriangle(), LibBoard::Board::setPenColor(), LibBoard::Board::setPenColorRGBf(), LibBoard::Board::setPenColorRGBi(), and State().

◆ unitFactor

double LibBoard::Board::State::unitFactor

The factor to be applied to arguments of the drawSomething() family.

Definition at line 949 of file Board.h.

Referenced by LibBoard::Board::operator<<(), LibBoard::Board::setUnit(), State(), and unit().

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