LibBoard::Point Struct Reference

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 &	operator+= (const Point &other)
Point &	operator-= (const Point &other)
Point &	operator*= (double s)
Point &	operator/= (double s)
Point	operator- () const
double	norm () const

Public Attributes
double	x
double	y

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, and examples/logo.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-(), and rotated().

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

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().

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(), and LibBoard::Text::rotate().

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::Text::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().

Member Data Documentation

double LibBoard::Point::x

The point's first coordinate

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

double LibBoard::Point::y

The point's second coordinate

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

---

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

• include/board/Point.h