LibBoard::Tools Namespace Reference

Classes
struct	EuclideanLine
class	MessageStream

Enumerations
enum	CaseSensitivity { CaseSensitive , CaseInsensitive }

Functions
std::vector< Point >	pathBoundaryPoints (const Path &path, double strokeWidth, LineCap lineCap, LineJoin lineJoin, double miterLimit=4.0)
Rect	pathBoundingBox (const Path &path, double strokeWidth, LineCap lineCap, LineJoin lineJoin, double miterLimit=4.0)
void	secured_strncpy (char *dst, const char *src, size_t count)
void	secured_ctime (char *str, const time_t *t, size_t count)
bool	base64encode (std::istream &in, std::ostream &, int linesize=80)
bool	stringEndsWith (const char *str, const char *end, CaseSensitivity sensitivity=CaseSensitive)
void	flushFile (const char *filename, std::ostream &out)
void	getEPSBoundingBox (const char *filename, Rect &rect)
bool	canCreateFile (const char *filename)
bool	canReadFile (const char *filename)
const char *	temporaryFilename (const char *extension)
void	initBoardRand (unsigned long seed)
unsigned int	boardRand ()
double	boardRandDouble ()
double	boardRandDouble (double min, double max)
bool	almostEqual (const double &a, const double &b)
double	mix (const double &a, const double &b, const double &time)
template<typename T >
void	unused (const T &,...)
template<typename T >
void	clamp (T &value, const T &min, const T &max)
template<typename T >
T	square (const T &t)
bool	solveQuadratic (double a, double b, double c, double &x1, double &x2)
double	rad2deg (double angle)
double	deg2rad (double angle)
bool	isASharpCorner (Point p1, Point p2, Point p3)
double	sharpCornerAngle (Point p1, Point p2, Point p3)
Point	intersection (EuclideanLine l1, EuclideanLine l2)
Point	exteriorMiterIntersection (Point p1, Point p2, Point p3, double strokeWidth)
Point	interiorMiterIntersection (Point p1, Point p2, Point p3, double strokeWidth)
void	exteriorBevelIntersection (Point p1, Point p2, Point p3, double strokeWidth, Point &a, Point &b)
std::vector< Point >	exteriorRoundIntersection (Point p1, Point p2, Point p3, double strokeWidth)
void	butCapExtremities (Point p1, Point p2, double strokeWidth, Point &a, Point &b)
void	squareCapExtremities (Point p1, Point p2, double strokeWidth, Point &a, Point &b)
std::vector< Point >	roundCapExtremities (Point p1, Point p2, double strokeWidth)

Variables
MessageStream	error
MessageStream	warning
MessageStream	notice

Enumeration Type Documentation

CaseSensitivity

enum LibBoard::Tools::CaseSensitivity

Enumerator
CaseSensitive
CaseInsensitive

Function Documentation

almostEqual()

bool LibBoard::Tools::almostEqual ( const double &  a, const double &  b  )

inline

Referenced by LibBoard::almostEqual(), LibBoard::Polyline::flushFIG(), LibBoard::orthogonal(), LibBoard::Bezier::pathThroughLocalExtremums(), LibBoard::Ellipse::scale(), and solveQuadratic().

base64encode()

bool LibBoard::Tools::base64encode	(	std::istream &	in,
		std::ostream &	out,
		int	linesize = 80
	)

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

boardRand()

unsigned int LibBoard::Tools::boardRand

(

)

Referenced by boardRandDouble(), boardRandDouble(), coordinate(), generateGroup(), main(), random_gray(), and temporaryFilename().

boardRandDouble() [1/2]

double LibBoard::Tools::boardRandDouble

(

)

References boardRand().

Referenced by julia(), main(), LibBoard::RoughVisitor::randomlySlided(), LibBoard::RoughVisitor::slideRandomlyAwayFromSegment(), LibBoard::RoughVisitor::slideRandomlyAwayFromSegment(), and LibBoard::RoughVisitor::slideRandomlyAwayFromSegmentInBox().

boardRandDouble() [2/2]

double LibBoard::Tools::boardRandDouble	(	double	min,
		double	max
	)

References boardRand().

butCapExtremities()

void LibBoard::Tools::butCapExtremities	(	Point	p1,
		Point	p2,
		double	strokeWidth,
		Point &	a,
		Point &	b
	)

References LibBoard::Point::normalise(), and LibBoard::Point::rotatedPI2().

Referenced by pathBoundaryPoints().

canCreateFile()

bool LibBoard::Tools::canCreateFile

(

const char *

filename

)

Referenced by temporaryFilename().

canReadFile()

bool LibBoard::Tools::canReadFile

(

const char *

filename

)

Referenced by temporaryFilename().

clamp()

template<typename T >

void LibBoard::Tools::clamp	(	T &	value,
		const T &	min,
		const T &	max
	)

Referenced by LibBoard::Color::setRGBf().

deg2rad()

double LibBoard::Tools::deg2rad ( double  angle )

inline

References M_PI.

exteriorBevelIntersection()

void LibBoard::Tools::exteriorBevelIntersection	(	Point	p1,
		Point	p2,
		Point	p3,
		double	strokeWidth,
		Point &	a,
		Point &	b
	)

References LibBoard::Point::normalise(), and LibBoard::Point::rotatedPI2().

Referenced by pathBoundaryPoints().

exteriorMiterIntersection()

Point LibBoard::Tools::exteriorMiterIntersection	(	Point	p1,
		Point	p2,
		Point	p3,
		double	strokeWidth
	)

References intersection(), LibBoard::Point::isInf(), LibBoard::Point::normalise(), and LibBoard::Point::rotatedPI2().

Referenced by pathBoundaryPoints().

exteriorRoundIntersection()

std::vector< Point > LibBoard::Tools::exteriorRoundIntersection	(	Point	p1,
		Point	p2,
		Point	p3,
		double	strokeWidth
	)

References LibBoard::Point::argument(), M_PI, M_PI_2, LibBoard::Point::normalise(), LibBoard::Point::normalised(), and LibBoard::Point::rotatedPI2().

Referenced by pathBoundaryPoints().

flushFile()

void LibBoard::Tools::flushFile	(	const char *	filename,
		std::ostream &	out
	)

Referenced by LibBoard::Image::flushPostscript().

getEPSBoundingBox()

void LibBoard::Tools::getEPSBoundingBox	(	const char *	filename,
		Rect &	rect
	)

References LibBoard::Rect::clear(), and error.

Referenced by LibBoard::Image::flushPostscript().

initBoardRand()

void LibBoard::Tools::initBoardRand

(

unsigned long

seed

)

Referenced by main().

interiorMiterIntersection()

Point LibBoard::Tools::interiorMiterIntersection	(	Point	p1,
		Point	p2,
		Point	p3,
		double	strokeWidth
	)

References intersection(), LibBoard::Point::normalise(), and LibBoard::Point::rotatedPI2().

intersection()

Point LibBoard::Tools::intersection	(	EuclideanLine	l1,
		EuclideanLine	l2
	)

References LibBoard::Tools::EuclideanLine::a, LibBoard::Tools::EuclideanLine::b, LibBoard::Tools::EuclideanLine::c, LibBoard::Point::Infinity, LibBoard::Point::x, and LibBoard::Point::y.

Referenced by exteriorMiterIntersection(), and interiorMiterIntersection().

isASharpCorner()

bool LibBoard::Tools::isASharpCorner	(	Point	p1,
		Point	p2,
		Point	p3
	)

Referenced by pathBoundaryPoints().

mix()

double LibBoard::Tools::mix ( const double &  a, const double &  b, const double &  time  )

inline

Referenced by LibBoard::mix().

pathBoundaryPoints()

std::vector< Point > LibBoard::Tools::pathBoundaryPoints	(	const Path &	path,
		double	strokeWidth,
		LineCap	lineCap,
		LineJoin	lineJoin,
		double	miterLimit = 4.0
	)

References LibBoard::BevelJoin, butCapExtremities(), LibBoard::ButtCap, exteriorBevelIntersection(), exteriorMiterIntersection(), exteriorRoundIntersection(), isASharpCorner(), LibBoard::Path::isClosed(), LibBoard::MiterJoin, LibBoard::Path::points(), LibBoard::RoundCap, roundCapExtremities(), LibBoard::RoundJoin, sharpCornerAngle(), LibBoard::SquareCap, squareCapExtremities(), LibBoard::Point::x, and LibBoard::Point::y.

Referenced by pathBoundingBox(), and strikeOut().

pathBoundingBox()

Rect LibBoard::Tools::pathBoundingBox	(	const Path &	path,
		double	strokeWidth,
		LineCap	lineCap,
		LineJoin	lineJoin,
		double	miterLimit = 4.0
	)

References LibBoard::Path::boundingBox(), LibBoard::Rect::growToContain(), pathBoundaryPoints(), and warning.

Referenced by LibBoard::Arrow::boundingBox(), LibBoard::Bezier::boundingBox(), LibBoard::Line::boundingBox(), and LibBoard::Polyline::boundingBox().

rad2deg()

double LibBoard::Tools::rad2deg ( double  angle )

inline

References M_PI.

roundCapExtremities()

std::vector< Point > LibBoard::Tools::roundCapExtremities	(	Point	p1,
		Point	p2,
		double	strokeWidth
	)

References LibBoard::Point::normalise().

Referenced by pathBoundaryPoints().

secured_ctime()

void LibBoard::Tools::secured_ctime ( char *  str, const time_t *  t, size_t  count  )

inline

Referenced by LibBoard::Board::saveEPS().

secured_strncpy()

void LibBoard::Tools::secured_strncpy ( char *  dst, const char *  src, size_t  count  )

inline

Referenced by main().

sharpCornerAngle()

double LibBoard::Tools::sharpCornerAngle	(	Point	p1,
		Point	p2,
		Point	p3
	)

Referenced by pathBoundaryPoints().

solveQuadratic()

bool LibBoard::Tools::solveQuadratic	(	double	a,
		double	b,
		double	c,
		double &	x1,
		double &	x2
	)

References almostEqual().

Referenced by LibBoard::hachures(), and LibBoard::Bezier::pathThroughLocalExtremums().

square()

template<typename T >

T LibBoard::Tools::square ( const T &  t )

inline

Referenced by LibBoard::hachures().

squareCapExtremities()

void LibBoard::Tools::squareCapExtremities	(	Point	p1,
		Point	p2,
		double	strokeWidth,
		Point &	a,
		Point &	b
	)

References LibBoard::Point::normalise(), LibBoard::Point::normalised(), and LibBoard::Point::rotatedPI2().

Referenced by pathBoundaryPoints().

stringEndsWith()

bool LibBoard::Tools::stringEndsWith	(	const char *	str,
		const char *	end,
		CaseSensitivity	sensitivity = CaseSensitive
	)

References CaseSensitive.

Referenced by LibBoard::Image::flushSVG(), and LibBoard::Board::save().

temporaryFilename()

const char * LibBoard::Tools::temporaryFilename

(

const char *

extension

)

References boardRand(), canCreateFile(), and canReadFile().

Referenced by LibBoard::Image::flushPostscript().

unused()

template<typename T >

void LibBoard::Tools::unused ( const T &  ,   ...  )

inline

Referenced by LibBoard::Bezier::flushFIG(), and LibBoard::Bezier::flushTikZ().

Variable Documentation

error

LibBoard::Tools::MessageStream LibBoard::Tools::error

extern

Referenced by LibBoard::ShapeList::append(), LibBoard::Color::Color(), LibBoard::Bezier::flushPostscript(), LibBoard::Image::flushPostscript(), LibBoard::Bezier::flushSVG(), LibBoard::Image::flushSVG(), LibBoard::Image::flushTikZ(), getEPSBoundingBox(), LibBoard::Image::Image(), LibBoard::ShapeList::last(), LibBoard::mix(), LibBoard::Board::pageRect(), and LibBoard::Board::toMillimeter().

notice

LibBoard::Tools::MessageStream LibBoard::Tools::notice

extern

Referenced by main().

warning

LibBoard::Tools::MessageStream LibBoard::Tools::warning

extern

Referenced by LibBoard::Path::boundingBox(), LibBoard::ShapeList::duplicateLast(), LibBoard::Bezier::flushFIG(), LibBoard::Bezier::flushTikZ(), main(), LibBoard::mix(), pathBoundingBox(), LibBoard::BoundingBoxExtractor::visit(), LibBoard::ShapeCounter::visit(), LibBoard::PenColorExtractor::visit(), and LibBoard::FillColorExtractor::visit().