Point< ValueType > Class Template Reference

A pair of (x, y) coordinates. More...

#include <juce_Point.h>

Public Types
using	FloatType = TypeHelpers::SmallestFloatType<ValueType>
	This type will be double if the Point's type is double, otherwise it will be float.

Public Member Functions
constexpr	Point ()=default
	Creates a point at the origin.
constexpr	Point (const Point &)=default
	Creates a copy of another point.
constexpr	Point (ValueType initialX, ValueType initialY) noexcept
	Creates a point from an (x, y) position.
Point &	operator= (const Point &)=default
	Copies this point from another one.
constexpr bool	operator== (Point other) const noexcept
constexpr bool	operator!= (Point other) const noexcept
constexpr bool	isOrigin () const noexcept
	Returns true if the point is (0, 0).
constexpr bool	isFinite () const noexcept
	Returns true if the coordinates are finite values.
constexpr ValueType	getX () const noexcept
	Returns the point's x coordinate.
constexpr ValueType	getY () const noexcept
	Returns the point's y coordinate.
void	setX (ValueType newX) noexcept
	Sets the point's x coordinate.
void	setY (ValueType newY) noexcept
	Sets the point's y coordinate.
constexpr Point	withX (ValueType newX) const noexcept
	Returns a point which has the same Y position as this one, but a new X.
constexpr Point	withY (ValueType newY) const noexcept
	Returns a point which has the same X position as this one, but a new Y.
void	setXY (ValueType newX, ValueType newY) noexcept
	Changes the point's x and y coordinates.
void	addXY (ValueType xToAdd, ValueType yToAdd) noexcept
	Adds a pair of coordinates to this value.
constexpr Point	translated (ValueType deltaX, ValueType deltaY) const noexcept
	Returns a point with a given offset from this one.
constexpr Point	operator+ (Point other) const noexcept
	Adds two points together.
Point &	operator+= (Point other) noexcept
	Adds another point's coordinates to this one.
constexpr Point	operator- (Point other) const noexcept
	Subtracts one points from another.
Point &	operator-= (Point other) noexcept
	Subtracts another point's coordinates to this one.
template<typename OtherType >
constexpr Point	operator* (Point< OtherType > other) const noexcept
	Multiplies two points together.
template<typename OtherType >
Point &	operator*= (Point< OtherType > other) noexcept
	Multiplies another point's coordinates to this one.
template<typename OtherType >
constexpr Point	operator/ (Point< OtherType > other) const noexcept
	Divides one point by another.
template<typename OtherType >
Point &	operator/= (Point< OtherType > other) noexcept
	Divides this point's coordinates by another.
template<typename OtherType >
constexpr Point	operator* (OtherType multiplier) const noexcept
	Returns a point whose coordinates are multiplied by a given scalar value.
template<typename OtherType >
constexpr Point	operator/ (OtherType divisor) const noexcept
	Returns a point whose coordinates are divided by a given scalar value.
template<typename FloatType >
Point &	operator*= (FloatType multiplier) noexcept
	Multiplies the point's coordinates by a scalar value.
template<typename FloatType >
Point &	operator/= (FloatType divisor) noexcept
	Divides the point's coordinates by a scalar value.
constexpr Point	operator- () const noexcept
	Returns the inverse of this point.
ValueType	getDistanceFromOrigin () const noexcept
	Returns the straight-line distance between this point and the origin.
ValueType	getDistanceFrom (Point other) const noexcept
	Returns the straight-line distance between this point and another one.
constexpr ValueType	getDistanceSquaredFromOrigin () const noexcept
	Returns the square of the straight-line distance between this point and the origin.
constexpr ValueType	getDistanceSquaredFrom (Point other) const noexcept
	Returns the square of the straight-line distance between this point and another one.
FloatType	getAngleToPoint (Point other) const noexcept
	Returns the angle from this point to another one.
template<typename T = ValueType, std::enable_if_t< std::is_floating_point_v< T >, int > = 0>
Point	rotatedAboutOrigin (ValueType angleRadians) const noexcept
	Returns the point that would be reached by rotating this point clockwise about the origin by the specified angle.
Point< FloatType >	getPointOnCircumference (float radius, float angle) const noexcept
	Taking this point to be the centre of a circle, this returns a point on its circumference.
Point< FloatType >	getPointOnCircumference (float radiusX, float radiusY, float angle) const noexcept
	Taking this point to be the centre of an ellipse, this returns a point on its circumference.
constexpr FloatType	getDotProduct (Point other) const noexcept
	Returns the dot-product of two points (x1 * x2 + y1 * y2).
void	applyTransform (const AffineTransform &transform) noexcept
	Uses a transform to change the point's coordinates.
Point	transformedBy (const AffineTransform &transform) const noexcept
	Returns the position of this point, if it is transformed by a given AffineTransform.
constexpr Point< int >	toInt () const noexcept
	Casts this point to a Point<int> object.
constexpr Point< float >	toFloat () const noexcept
	Casts this point to a Point<float> object.
constexpr Point< double >	toDouble () const noexcept
	Casts this point to a Point<double> object.
constexpr Point< int >	roundToInt () const noexcept
	Casts this point to a Point<int> object using roundToInt() to convert the values.
String	toString () const
	Returns the point as a string in the form "x, y".

Public Attributes
ValueType	x {}
	The point's X coordinate.
ValueType	y {}
	The point's Y coordinate.

Detailed Description

template<typename ValueType>
class Point< ValueType >

A pair of (x, y) coordinates.

The ValueType template should be a primitive type such as int, float, double, rather than a class.

See also

Line, Path, AffineTransform

Member Typedef Documentation

FloatType

template<typename ValueType >

using Point< ValueType >::FloatType = TypeHelpers::SmallestFloatType<ValueType>

This type will be double if the Point's type is double, otherwise it will be float.

Constructor & Destructor Documentation

Point() [1/3]

template<typename ValueType >

Point< ValueType >::Point ( )

constexprdefault

Creates a point at the origin.

Point() [2/3]

template<typename ValueType >

Point< ValueType >::Point ( const Point< ValueType > & )

constexprdefault

Creates a copy of another point.

Point() [3/3]

template<typename ValueType >

Point< ValueType >::Point ( ValueType initialX, ValueType initialY )

constexprnoexcept

Creates a point from an (x, y) position.

Member Function Documentation

operator=()

template<typename ValueType >

Point & Point< ValueType >::operator= ( const Point< ValueType > & )

default

Copies this point from another one.

operator==()

template<typename ValueType >

bool Point< ValueType >::operator== ( Point< ValueType > other ) const

constexprnoexcept

operator!=()

template<typename ValueType >

bool Point< ValueType >::operator!= ( Point< ValueType > other ) const

constexprnoexcept

References operator==().

isOrigin()

template<typename ValueType >

bool Point< ValueType >::isOrigin ( ) const

constexprnoexcept

Returns true if the point is (0, 0).

References operator==(), and Point.

isFinite()

template<typename ValueType >

bool Point< ValueType >::isFinite ( ) const

constexprnoexcept

Returns true if the coordinates are finite values.

References juce_isfinite(), x, and y.

getX()

template<typename ValueType >

ValueType Point< ValueType >::getX ( ) const

constexprnoexcept

Returns the point's x coordinate.

References x.

getY()

template<typename ValueType >

ValueType Point< ValueType >::getY ( ) const

constexprnoexcept

Returns the point's y coordinate.

References y.

setX()

template<typename ValueType >

void Point< ValueType >::setX ( ValueType newX )

noexcept

Sets the point's x coordinate.

References x.

setY()

template<typename ValueType >

void Point< ValueType >::setY ( ValueType newY )

noexcept

Sets the point's y coordinate.

References y.

withX()

template<typename ValueType >

Point Point< ValueType >::withX ( ValueType newX ) const

constexprnoexcept

Returns a point which has the same Y position as this one, but a new X.

References Point, and y.

withY()

template<typename ValueType >

Point Point< ValueType >::withY ( ValueType newY ) const

constexprnoexcept

Returns a point which has the same X position as this one, but a new Y.

References Point, and x.

setXY()

template<typename ValueType >

void Point< ValueType >::setXY ( ValueType newX, ValueType newY )

noexcept

Changes the point's x and y coordinates.

References x, and y.

addXY()

template<typename ValueType >

void Point< ValueType >::addXY ( ValueType xToAdd, ValueType yToAdd )

noexcept

Adds a pair of coordinates to this value.

References x, and y.

translated()

template<typename ValueType >

Point Point< ValueType >::translated ( ValueType deltaX, ValueType deltaY ) const

constexprnoexcept

Returns a point with a given offset from this one.

References Point, x, and y.

operator+()

template<typename ValueType >

Point Point< ValueType >::operator+ ( Point< ValueType > other ) const

constexprnoexcept

Adds two points together.

References Point, x, and y.

operator+=()

template<typename ValueType >

Point & Point< ValueType >::operator+= ( Point< ValueType > other )

noexcept

Adds another point's coordinates to this one.

References x, and y.

operator-() [1/2]

template<typename ValueType >

Point Point< ValueType >::operator- ( Point< ValueType > other ) const

constexprnoexcept

Subtracts one points from another.

References Point, x, and y.

operator-=()

template<typename ValueType >

Point & Point< ValueType >::operator-= ( Point< ValueType > other )

noexcept

Subtracts another point's coordinates to this one.

References Point< ValueType >::x, x, and y.

operator*() [1/2]

template<typename ValueType >

template<typename OtherType >

Point Point< ValueType >::operator* ( Point< OtherType > other ) const

constexprnoexcept

Multiplies two points together.

References Point, x, and y.

operator*=() [1/2]

template<typename ValueType >

template<typename OtherType >

Point & Point< ValueType >::operator*= ( Point< OtherType > other )

noexcept

Multiplies another point's coordinates to this one.

operator/() [1/2]

template<typename ValueType >

template<typename OtherType >

Point Point< ValueType >::operator/ ( Point< OtherType > other ) const

constexprnoexcept

Divides one point by another.

References Point, x, and y.

operator/=() [1/2]

template<typename ValueType >

template<typename OtherType >

Point & Point< ValueType >::operator/= ( Point< OtherType > other )

noexcept

Divides this point's coordinates by another.

operator*() [2/2]

template<typename ValueType >

template<typename OtherType >

Point Point< ValueType >::operator* ( OtherType multiplier ) const

constexprnoexcept

Returns a point whose coordinates are multiplied by a given scalar value.

References Point, x, and y.

operator/() [2/2]

template<typename ValueType >

template<typename OtherType >

Point Point< ValueType >::operator/ ( OtherType divisor ) const

constexprnoexcept

Returns a point whose coordinates are divided by a given scalar value.

References Point, x, and y.

operator*=() [2/2]

template<typename ValueType >

template<typename FloatType >

Point & Point< ValueType >::operator*= ( FloatType multiplier )

noexcept

Multiplies the point's coordinates by a scalar value.

References x, and y.

operator/=() [2/2]

template<typename ValueType >

template<typename FloatType >

Point & Point< ValueType >::operator/= ( FloatType divisor )

noexcept

Divides the point's coordinates by a scalar value.

References x, and y.

operator-() [2/2]

template<typename ValueType >

Point Point< ValueType >::operator- ( ) const

constexprnoexcept

Returns the inverse of this point.

References Point, x, and y.

getDistanceFromOrigin()

template<typename ValueType >

ValueType Point< ValueType >::getDistanceFromOrigin ( ) const

noexcept

Returns the straight-line distance between this point and the origin.

References juce_hypot(), x, and y.

getDistanceFrom()

template<typename ValueType >

ValueType Point< ValueType >::getDistanceFrom ( Point< ValueType > other ) const

noexcept

Returns the straight-line distance between this point and another one.

References juce_hypot(), x, and y.

getDistanceSquaredFromOrigin()

template<typename ValueType >

ValueType Point< ValueType >::getDistanceSquaredFromOrigin ( ) const

constexprnoexcept

Returns the square of the straight-line distance between this point and the origin.

References x, and y.

getDistanceSquaredFrom()

template<typename ValueType >

ValueType Point< ValueType >::getDistanceSquaredFrom ( Point< ValueType > other ) const

constexprnoexcept

Returns the square of the straight-line distance between this point and another one.

getAngleToPoint()

template<typename ValueType >

FloatType Point< ValueType >::getAngleToPoint ( Point< ValueType > other ) const

noexcept

Returns the angle from this point to another one.

Taking this point to be the centre of a circle, and the other point being a position on the circumference, the return value is the number of radians clockwise from the 12 o'clock direction. So 12 o'clock = 0, 3 o'clock = Pi/2, 6 o'clock = Pi, 9 o'clock = -Pi/2

References x, and y.

rotatedAboutOrigin()

template<typename ValueType >

template<typename T = ValueType, std::enable_if_t< std::is_floating_point_v< T >, int > = 0>

Point Point< ValueType >::rotatedAboutOrigin ( ValueType angleRadians ) const

noexcept

Returns the point that would be reached by rotating this point clockwise about the origin by the specified angle.

References Point, x, and y.

getPointOnCircumference() [1/2]

template<typename ValueType >

Point< FloatType > Point< ValueType >::getPointOnCircumference ( float radius, float angle ) const

noexcept

Taking this point to be the centre of a circle, this returns a point on its circumference.

Parameters

radius	the radius of the circle.
angle	the angle of the point, in radians clockwise from the 12 o'clock position.

References Point, x, and y.

getPointOnCircumference() [2/2]

template<typename ValueType >

Point< FloatType > Point< ValueType >::getPointOnCircumference ( float radiusX, float radiusY, float angle ) const

noexcept

Taking this point to be the centre of an ellipse, this returns a point on its circumference.

Parameters

radiusX	the horizontal radius of the circle.
radiusY	the vertical radius of the circle.
angle	the angle of the point, in radians clockwise from the 12 o'clock position.

References Point, x, and y.

getDotProduct()

template<typename ValueType >

FloatType Point< ValueType >::getDotProduct ( Point< ValueType > other ) const

constexprnoexcept

Returns the dot-product of two points (x1 * x2 + y1 * y2).

References x, and y.

applyTransform()

template<typename ValueType >

void Point< ValueType >::applyTransform ( const AffineTransform & transform )

noexcept

Uses a transform to change the point's coordinates.

This will only compile if ValueType = float!

See also

AffineTransform::transformPoint

References x, and y.

transformedBy()

template<typename ValueType >

Point Point< ValueType >::transformedBy ( const AffineTransform & transform ) const

noexcept

Returns the position of this point, if it is transformed by a given AffineTransform.

References Point, x, and y.

toInt()

template<typename ValueType >

Point< int > Point< ValueType >::toInt ( ) const

constexprnoexcept

Casts this point to a Point<int> object.

References x, and y.

toFloat()

template<typename ValueType >

Point< float > Point< ValueType >::toFloat ( ) const

constexprnoexcept

Casts this point to a Point<float> object.

References x, and y.

toDouble()

template<typename ValueType >

Point< double > Point< ValueType >::toDouble ( ) const

constexprnoexcept

Casts this point to a Point<double> object.

References Point, x, and y.

roundToInt()

template<typename ValueType >

Point< int > Point< ValueType >::roundToInt ( ) const

constexprnoexcept

Casts this point to a Point<int> object using roundToInt() to convert the values.

References x, and y.

toString()

template<typename ValueType >

String Point< ValueType >::toString

(

)

const

Returns the point as a string in the form "x, y".

References x, and y.

Member Data Documentation

x

template<typename ValueType >

ValueType Point< ValueType >::x {}

The point's X coordinate.

Referenced by Point< ValueType >::operator-=().

y

template<typename ValueType >

ValueType Point< ValueType >::y {}

The point's Y coordinate.

---

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

• juce_Point.h