Struct representing a 2D point. More...

#include <Point.h>

Public Member Functions
	Point ()

	Point (const Point &other)

	Point (double x, double y)

void	get (double &x, double &y) const

Point &	rotate (double angle)

Point	rotated (double angle) const

Point &	rotate (double angle, const Point &center)

Point	rotated (double angle, const Point &center) const

Point	rotatedPI2 () const

Point &	operator+= (const Point &other)

Point &	operator-= (const Point &other)

Point &	operator*= (double s)

Point &	operator/= (double s)

Point	operator- () const

double	norm () const

Point &	normalise ()

Point	normalised () const

double	argument () const

bool	isInf () const

Public Attributes
double	x

double	y

Static Public Attributes
static Point	Infinity

Detailed Description

Struct representing a 2D point.

The Point structure.

Examples:: examples/clipping.cpp, examples/example1.cpp, examples/example2.cpp, examples/flag.cpp, examples/koch.cpp, examples/logo.cpp, examples/stroke_path.cpp, and examples/tilings.cpp.

Constructor & Destructor Documentation

LibBoard::Point::Point ( )

inline

Point constructor.

Parameters

x	The point's first coordinate.
y	The point's second coordinate.

Referenced by operator-(), rotated(), and rotatedPI2().

LibBoard::Point::Point ( const Point & other )

inline

Point constructor.

Parameters

x	The point's first coordinate.
y	The point's second coordinate.

LibBoard::Point::Point	(	double	x,
		double	y
	)

inline

Point constructor.

Parameters

x	The point's first coordinate.
y	The point's second coordinate.

Member Function Documentation

double LibBoard::Point::argument ( ) const

inline

Return the argument of the point (seen as a complex number).

Returns: The argument of the point.

References x, and y.

void LibBoard::Point::get	(	double &	x,
		double &	y
	)		const

inline

Get the values of the x and y values.

Parameters

x	Reference to the x to be set.
y	Reference to the y to be set.

References x, and y.

Referenced by LibBoard::Dot::rotate(), LibBoard::Line::rotate(), LibBoard::Line::rotated(), and LibBoard::Arrow::rotated().

bool LibBoard::Point::isInf ( ) const

inline

Returns true if point is (Inf,Inf).

Returns: true if point is (Inf,Inf).

double LibBoard::Point::norm ( ) const

inline

Compute the norm of the point (seen as a vector).

Returns: The norm of the point.

References x, and y.

Referenced by LibBoard::Rectangle::flushSVG(), normalise(), and normalised().

Point & LibBoard::Point::normalise ( )

inline

Make the point (seen as a vector) a unit vector.

Returns: The point itself.

Examples:: examples/stroke_path.cpp.

References norm(), x, and y.

Point LibBoard::Point::normalised ( ) const

inline

Return a normalized copy of the point (seen as a vector).

Returns: A unit vector.

References norm().

Point & LibBoard::Point::operator*= ( double s )

inline

Scale the point's coordinates.

Parameters

s	A scaling factor.

Returns: The point itself, once scaled.

References x, and y.

Point & LibBoard::Point::operator+= ( const Point & other )

inline

Move the point given a translation vector (given as another Point).

Parameters

other A point seen as a translation vector.

Returns: The point itself, once translated.

References x, and y.

Point LibBoard::Point::operator- ( ) const

inline

Get the opposite copy of the point.

Returns: The opposite copy of the point.

References Point(), x, and y.

Point & LibBoard::Point::operator-= ( const Point & other )

inline

Move (backward) the point given a translation vector (given as another Point).

Parameters

other A point seen as a translation vector.

Returns: The point itself, once translated.

References x, and y.

Point & LibBoard::Point::operator/= ( double s )

inline

Downscale the point's coordinates.

Parameters

s	A (down)scaling factor.

Returns: The point itself, once scaled.

References x, and y.

Point & LibBoard::Point::rotate ( double angle )

inline

Rotate the point with a given angle around the origin (0,0)

Parameters

angle The rotation angle.

References x, and y.

Referenced by rotate(), LibBoard::Dot::rotate(), LibBoard::Line::rotate(), LibBoard::Circle::rotate(), LibBoard::Line::rotated(), and LibBoard::Arrow::rotated().

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

inline

Rotate the point, given a rotation center and an angle.

Parameters

angle	The rotation angle (in radians).
center	The rotation center.

Returns: The point itself (once rotated).

References rotate().

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

inline

Get a rotated copy of the point, around the origin, by a given angle.

Parameters

angle The rotation angle (in radians).

Returns: The rotated point.

Examples:: examples/koch.cpp.

References Point().

Referenced by LibBoard::Ellipse::rotate().

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

inline

Get a rotated copy of the point, given a rotation center and an angle.

Parameters

angle	The rotation angle (in radians).
center	The rotation center.

Returns: A rotated copy of the point.

References Point().

Point LibBoard::Point::rotatedPI2 ( ) const

inline

Get a PI/2 rotated copy of the point around (0,0), counterclockwise.

Returns: A rotated copy of the point.

Examples:: examples/stroke_path.cpp.

References Point(), x, and y.

Member Data Documentation

double LibBoard::Point::x

The point's first coordinate

Referenced by LibBoard::ShapeList::addTiling(), LibBoard::ShapeList::append(), argument(), LibBoard::Ellipse::boundingBox(), LibBoard::Board::drawArrow(), LibBoard::Board::drawLine(), LibBoard::Board::drawTriangle(), LibBoard::Board::fillTriangle(), LibBoard::Ellipse::flushFIG(), LibBoard::GouraudTriangle::flushPostscript(), LibBoard::Ellipse::flushPostscript(), LibBoard::GouraudTriangle::flushSVG(), LibBoard::Ellipse::flushSVG(), LibBoard::Circle::flushSVG(), LibBoard::Ellipse::flushTikZ(), LibBoard::Circle::flushTikZ(), get(), LibBoard::Board::makeGrid(), LibBoard::Shape::moveCenter(), norm(), normalise(), operator*=(), operator+=(), operator-(), operator-=(), operator/=(), rotate(), LibBoard::Ellipse::rotate(), rotatedPI2(), LibBoard::ShapeList::scale(), LibBoard::Board::scale(), LibBoard::Path::scale(), LibBoard::Group::scale(), and LibBoard::Line::scale().

double LibBoard::Point::y

The point's second coordinate

Referenced by LibBoard::ShapeList::addTiling(), LibBoard::ShapeList::append(), argument(), LibBoard::Ellipse::boundingBox(), LibBoard::Board::drawArrow(), LibBoard::Board::drawLine(), LibBoard::Board::drawTriangle(), LibBoard::Board::fillTriangle(), LibBoard::Ellipse::flushFIG(), LibBoard::GouraudTriangle::flushPostscript(), LibBoard::Ellipse::flushPostscript(), LibBoard::GouraudTriangle::flushSVG(), LibBoard::Ellipse::flushSVG(), LibBoard::Circle::flushSVG(), LibBoard::Ellipse::flushTikZ(), LibBoard::Circle::flushTikZ(), get(), LibBoard::Board::makeGrid(), LibBoard::Shape::moveCenter(), norm(), normalise(), operator*=(), operator+=(), operator-(), operator-=(), operator/=(), rotate(), LibBoard::Ellipse::rotate(), rotatedPI2(), LibBoard::ShapeList::scale(), LibBoard::Board::scale(), LibBoard::Path::scale(), LibBoard::Group::scale(), and LibBoard::Line::scale().

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

include/board/Point.h
src/Point.cpp

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation