Declaration of the Board class. More...

#include <ostream>
#include <string>
#include <vector>
#include "BoardConfig.h"
#include "board/Arrow.h"
#include "board/Bezier.h"
#include "board/BoardFontText.h"
#include "board/Dot.h"
#include "board/Ellipse.h"
#include "board/Exception.h"
#include "board/Group.h"
#include "board/Image.h"
#include "board/Line.h"
#include "board/Path.h"
#include "board/Point.h"
#include "board/Polyline.h"
#include "board/RoughVisitor.h"
#include "board/Shape.h"
#include "board/ShapeList.h"
#include "board/SketchFilter.h"
#include "board/Style.h"
#include "board/Text.h"

Classes
struct	LibBoard::Board
	Class for EPS, FIG or SVG drawings. More...

struct	LibBoard::Board::State

Functions
Group	LibBoard::grid (Point topLeft, size_t columns, size_t rows, double width, double height, Color penColor, Color fillColor, double lineWidth, const LineStyle style=SolidStyle, const LineCap cap=ButtCap, const LineJoin join=MiterJoin)

Group	LibBoard::grid (Point topLeft, size_t columns, size_t rows, double width, double height, const Style &style=Style::defaultStyle())

Group	LibBoard::cross (Point p, const Style &style=Style::defaultStyle())

Group	LibBoard::array (Point topLeft, const std::vector< Color > &colors, unsigned int columns, unsigned int rows, double pixelWidth, double pixelHeight=0.0, double lineWidth=0.0)
	Produce a rectangular color matrix. More...

Group	LibBoard::framed (const Shape &shape, const Color &color=Style::defaultPenColor(), double lineWidth=Style::defaultLineWidth(), double margin=0.0, int sketchyCount=0)
	Surround a shape with a rectangular frame. More...

Polyline	LibBoard::bezierControls (const Bezier &bezier, const Style &style=Style::defaultStyle())
	Produce a polyline of the Biezer vertices and control points. More...

Detailed Description

Declaration of the Board class.

Author: Sebastien Fourey (GREYC)

Date: Aug 2007

@copyright This source code is part of the Board project, a C++ library whose purpose is to allow simple drawings in EPS, FIG or SVG files. Copyright (C) 2007 Sebastien Fourey http://foureys.users.greyc.fr/

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Author: Sebastien Fourey (GREYC)

@copyright This source code is part of the Board project, a C++ library whose purpose is to allow simple drawings in EPS, FIG or SVG files. Copyright (C) 2007 Sebastien Fourey http://foureys.users.greyc.fr/

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Function Documentation

◆ array()

Group LibBoard::array	(	Point	topLeft,
		const std::vector< Color > &	colors,
		unsigned int	columns,
		unsigned int	rows,
		double	pixelWidth,
		double	pixelHeight = `0.0`,
		double	lineWidth = `0.0`
	)

Produce a rectangular color matrix.

Parameters

topLeft
colors
columns
rows
pixelWidth
pixelHeight	if zero (default), then it take the same value as pixelHeight
lineWidth	if zero, pixels are drawn with Color::Null outline (i.e. color is "none")

Returns: A group of rows x columns rectangles colored after given vector

References LibBoard::array().

Referenced by LibBoard::array().

◆ bezierControls()

Polyline LibBoard::bezierControls	(	const Bezier &	bezier,
		const Style &	style = `Style::defaultStyle()`
	)

Produce a polyline of the Biezer vertices and control points.

Parameters

bezier	A Bezier
style	Style of the polyline

Returns: A polyline showing the Bezier points and controls

Examples: examples/bezier.cpp.

References LibBoard::Path::back(), and LibBoard::bezierControls().

Referenced by LibBoard::bezierControls().

◆ cross()

Group LibBoard::cross	(	Point	p,
		const Style &	style = `Style::defaultStyle()`
	)

Make a small cross

Parameters

p
style

Returns: A cross made of two lines, centered at point p

Examples: examples/bezier.cpp, examples/clipping.cpp, and examples/traversal.cpp.

References LibBoard::cross(), and LibBoard::Point::translated().

Referenced by LibBoard::cross().

◆ framed()

Group LibBoard::framed	(	const Shape &	shape,
		const Color &	color = `Style::defaultPenColor()`,
		double	lineWidth = `Style::defaultLineWidth()`,
		double	margin = `0.0`,
		int	sketchyCount = `0`
	)

Surround a shape with a rectangular frame.

Parameters

shape	A shape
color	Frame color
lineWidth	Frame line width
margin	Frame inner mergin
sketchyCount	If set to zero, the frame is a straight one, otherwise a sketchy frame is produced with given repetition count.

Returns: A group of the shape with its frame

References LibBoard::framed().

Referenced by LibBoard::framed().

◆ grid() [1/2]

Group LibBoard::grid	(	Point	topLeft,
		size_t	columns,
		size_t	rows,
		double	width,
		double	height,
		Color	penColor,
		Color	fillColor,
		double	lineWidth,
		const LineStyle	style = `SolidStyle`,
		const LineCap	cap = `ButtCap`,
		const LineJoin	join = `MiterJoin`
	)

Build a grid with specified number of rows and columns and a given size.

Parameters

topLeft	Coordinates of the top left point of the grid.
columns	Number of columns of the grid.
rows	Number of rows of the grid.
width	Width of the grid.
height	Height of the grid.
penColor	Color of the lines.
fillColor	Background color.
lineWidth	Line width.
style	Line style (default is Board::SolidStyle).
cap	Line cap (default is Board::ButtCap).
join	Line join (default is Board::MiterJoin).

Returns: The grid as a group.

Examples: examples/tilings.cpp.

References LibBoard::grid().

Referenced by LibBoard::grid().

◆ grid() [2/2]

Group LibBoard::grid	(	Point	topLeft,
		size_t	columns,
		size_t	rows,
		double	width,
		double	height,
		const Style &	style = `Style::defaultStyle()`
	)

Build a grid with specified number of rows and columns and a given size.

Parameters

topLeft	Coordinates of the top left point of the grid.
columns	Number of columns of the grid.
rows	Number of rows of the grid.
width	Width of the grid.
height	Height of the grid.
style	Shape style

Returns: The grid as a group.

References LibBoard::grid().

Classes

Functions

Detailed Description

Function Documentation

◆ array()

◆ bezierControls()

◆ cross()

◆ framed()

◆ grid() [1/2]

◆ grid() [2/2]