juce::Point< ValueType > Class Template Reference

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

#include <juce_Point.h>

Inheritance diagram for juce::Point< ValueType >:

Collaboration diagram for juce::Point< ValueType >:

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

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

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

Detailed Description

template<typename ValueType>
class juce::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

{Graphics}

Member Typedef Documentation

FloatType

template<typename ValueType>

using juce::Point< ValueType >::FloatType = typename TypeHelpers::SmallestFloatType<ValueType>::type

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>

JUCE_CONSTEXPR juce::Point< ValueType >::Point ( )

default

Creates a point at the origin.

Referenced by juce::Point< int >::operator*(), juce::Point< int >::operator+(), juce::Point< int >::operator-(), juce::Point< int >::operator/(), juce::Point< int >::rotatedAboutOrigin(), juce::Point< int >::transformedBy(), juce::Point< int >::translated(), juce::Point< int >::withX(), and juce::Point< int >::withY().

Point() [2/3]

template<typename ValueType>

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

default

Creates a copy of another point.

Point() [3/3]

template<typename ValueType>

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

inlinenoexcept

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

Member Function Documentation

addXY()

template<typename ValueType>

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

inlinenoexcept

Adds a pair of coordinates to this value.

applyTransform()

template<typename ValueType>

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

inlinenoexcept

Uses a transform to change the point's coordinates.

This will only compile if ValueType = float!

See also

AffineTransform::transformPoint

getAngleToPoint()

template<typename ValueType>

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

inlinenoexcept

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

getDistanceFrom()

template<typename ValueType>

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

inlinenoexcept

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

getDistanceFromOrigin()

template<typename ValueType>

ValueType juce::Point< ValueType >::getDistanceFromOrigin ( ) const

inlinenoexcept

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

getDistanceSquaredFrom()

template<typename ValueType>

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

inlinenoexcept

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

getDistanceSquaredFromOrigin()

template<typename ValueType>

JUCE_CONSTEXPR ValueType juce::Point< ValueType >::getDistanceSquaredFromOrigin ( ) const

inlinenoexcept

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

getDotProduct()

template<typename ValueType>

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

inlinenoexcept

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

getPointOnCircumference() [1/2]

template<typename ValueType>

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

inlinenoexcept

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.

getPointOnCircumference() [2/2]

template<typename ValueType>

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

inlinenoexcept

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.

getX()

template<typename ValueType>

JUCE_CONSTEXPR ValueType juce::Point< ValueType >::getX ( ) const

inlinenoexcept

Returns the point's x coordinate.

getY()

template<typename ValueType>

JUCE_CONSTEXPR ValueType juce::Point< ValueType >::getY ( ) const

inlinenoexcept

Returns the point's y coordinate.

isFinite()

template<typename ValueType>

JUCE_CONSTEXPR bool juce::Point< ValueType >::isFinite ( ) const

inlinenoexcept

Returns true if the coordinates are finite values.

isOrigin()

template<typename ValueType>

JUCE_CONSTEXPR bool juce::Point< ValueType >::isOrigin ( ) const

inlinenoexcept

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

Referenced by juce::RenderingHelpers::TranslationOrTransform::isIdentity().

operator!=()

template<typename ValueType>

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

inlinenoexcept

operator*() [1/2]

template<typename ValueType>

template<typename OtherType >

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

inlinenoexcept

Multiplies two points together.

operator*() [2/2]

template<typename ValueType>

template<typename FloatType >

JUCE_CONSTEXPR Point juce::Point< ValueType >::operator* ( FloatType  multiplier ) const

inlinenoexcept

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

operator*=() [1/2]

template<typename ValueType>

template<typename OtherType >

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

inlinenoexcept

Multiplies another point's coordinates to this one.

operator*=() [2/2]

template<typename ValueType>

template<typename FloatType >

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

inlinenoexcept

Multiplies the point's coordinates by a scalar value.

operator+()

template<typename ValueType>

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

inlinenoexcept

Adds two points together.

operator+=()

template<typename ValueType>

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

inlinenoexcept

Adds another point's coordinates to this one.

operator-() [1/2]

template<typename ValueType>

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

inlinenoexcept

Subtracts one points from another.

operator-() [2/2]

template<typename ValueType>

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

inlinenoexcept

Returns the inverse of this point.

operator-=()

template<typename ValueType>

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

inlinenoexcept

Subtracts another point's coordinates to this one.

operator/() [1/2]

template<typename ValueType>

template<typename OtherType >

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

inlinenoexcept

Divides one point by another.

operator/() [2/2]

template<typename ValueType>

template<typename FloatType >

JUCE_CONSTEXPR Point juce::Point< ValueType >::operator/ ( FloatType  divisor ) const

inlinenoexcept

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

operator/=() [1/2]

template<typename ValueType>

template<typename OtherType >

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

inlinenoexcept

Divides this point's coordinates by another.

operator/=() [2/2]

template<typename ValueType>

template<typename FloatType >

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

inlinenoexcept

Divides the point's coordinates by a scalar value.

operator=()

template<typename ValueType>

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

default

Copies this point from another one.

Referenced by juce::Point< int >::Point().

operator==()

template<typename ValueType>

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

inlinenoexcept

rotatedAboutOrigin()

template<typename ValueType>

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

inlinenoexcept

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

roundToInt()

template<typename ValueType>

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

inlinenoexcept

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

setX()

template<typename ValueType>

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

inlinenoexcept

Sets the point's x coordinate.

setXY()

template<typename ValueType>

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

inlinenoexcept

Changes the point's x and y coordinates.

setY()

template<typename ValueType>

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

inlinenoexcept

Sets the point's y coordinate.

toDouble()

template<typename ValueType>

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

inlinenoexcept

Casts this point to a Point<double> object.

toFloat()

template<typename ValueType>

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

inlinenoexcept

Casts this point to a Point<float> object.

Referenced by juce::RenderingHelpers::TranslationOrTransform::translated().

toInt()

template<typename ValueType>

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

inlinenoexcept

Casts this point to a Point<int> object.

toString()

template<typename ValueType>

String juce::Point< ValueType >::toString ( ) const

inline

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

transformedBy()

template<typename ValueType>

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

inlinenoexcept

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

Referenced by juce::RenderingHelpers::TranslationOrTransform::deviceSpaceToUserSpace().

translated()

template<typename ValueType>

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

inlinenoexcept

Returns a point with a given offset from this one.

withX()

template<typename ValueType>

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

inlinenoexcept

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

withY()

template<typename ValueType>

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

inlinenoexcept

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

Member Data Documentation

x

template<typename ValueType>

ValueType juce::Point< ValueType >::x {}

The point's X coordinate.

Referenced by juce::Point< int >::addXY(), juce::Point< int >::applyTransform(), juce::RenderingHelpers::CachedGlyphEdgeTable< RendererType >::draw(), juce::Point< int >::getAngleToPoint(), juce::Point< int >::getDistanceFrom(), juce::Point< int >::getDistanceFromOrigin(), juce::Point< int >::getDistanceSquaredFromOrigin(), juce::Point< int >::getDotProduct(), juce::Point< int >::getPointOnCircumference(), juce::Point< int >::getX(), juce::Point< int >::isFinite(), juce::Point< int >::isOrigin(), juce::Point< int >::operator!=(), juce::Point< int >::operator*(), juce::Point< int >::operator*=(), juce::Point< int >::operator+(), juce::Point< int >::operator+=(), juce::Point< int >::operator-(), juce::Point< int >::operator-=(), juce::Point< int >::operator/(), juce::Point< int >::operator/=(), juce::Point< int >::operator==(), juce::RenderingHelpers::GradientPixelIterators::Radial::Radial(), juce::Point< int >::rotatedAboutOrigin(), juce::Point< int >::roundToInt(), juce::Point< int >::setX(), juce::Point< int >::setXY(), juce::Point< int >::toDouble(), juce::Point< int >::toFloat(), juce::Point< int >::toInt(), juce::Point< int >::toString(), juce::Point< int >::transformedBy(), juce::RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion::translate(), juce::Point< int >::translated(), and juce::Point< int >::withY().

y

template<typename ValueType>

ValueType juce::Point< ValueType >::y {}

The point's Y coordinate.

Referenced by juce::Point< int >::addXY(), juce::Point< int >::applyTransform(), juce::RenderingHelpers::CachedGlyphEdgeTable< RendererType >::draw(), juce::Point< int >::getAngleToPoint(), juce::Point< int >::getDistanceFrom(), juce::Point< int >::getDistanceFromOrigin(), juce::Point< int >::getDistanceSquaredFromOrigin(), juce::Point< int >::getDotProduct(), juce::Point< int >::getPointOnCircumference(), juce::Point< int >::getY(), juce::Point< int >::isFinite(), juce::Point< int >::isOrigin(), juce::Point< int >::operator!=(), juce::Point< int >::operator*(), juce::Point< int >::operator*=(), juce::Point< int >::operator+(), juce::Point< int >::operator+=(), juce::Point< int >::operator-(), juce::Point< int >::operator-=(), juce::Point< int >::operator/(), juce::Point< int >::operator/=(), juce::Point< int >::operator==(), juce::Point< int >::rotatedAboutOrigin(), juce::Point< int >::roundToInt(), juce::Point< int >::setXY(), juce::Point< int >::setY(), juce::Point< int >::toDouble(), juce::Point< int >::toFloat(), juce::Point< int >::toInt(), juce::Point< int >::toString(), juce::Point< int >::transformedBy(), juce::RenderingHelpers::ClipRegions< SavedStateType >::EdgeTableRegion::translate(), juce::Point< int >::translated(), and juce::Point< int >::withX().

---

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

• juce_Point.h