Represents a parallelogram that is defined by 3 points. More...

#include "juce_Parallelogram.h"

Public Member Functions
	Parallelogram ()=default
	Creates a parallelogram with zero size at the origin.

	Parallelogram (const Parallelogram &)=default
	Creates a copy of another parallelogram.

	Parallelogram (Point< ValueType > topLeftPosition, Point< ValueType > topRightPosition, Point< ValueType > bottomLeftPosition) noexcept
	Creates a parallelogram based on 3 points.

	Parallelogram (Rectangle< ValueType > rectangle) noexcept
	Creates a parallelogram from a rectangle.

Parallelogram &	operator= (const Parallelogram &)=default

	~Parallelogram ()=default
	Destructor.

bool	isEmpty () const noexcept
	Returns true if the parallelogram has a width or height of more than zero.

bool	isFinite () const noexcept
	Returns true if the parallelogram's coordinates are all finite numbers, i.e.

ValueType	getWidth () const noexcept
	Returns the width of the parallelogram (i.e.

ValueType	getHeight () const noexcept
	Returns the height of the parallelogram (i.e.

Point< ValueType >	getTopLeft () const noexcept
	Returns the parallelogram's top-left position as a Point.

Point< ValueType >	getTopRight () const noexcept
	Returns the parallelogram's top-right position as a Point.

Point< ValueType >	getBottomLeft () const noexcept
	Returns the parallelogram's bottom-left position as a Point.

Point< ValueType >	getBottomRight () const noexcept
	Returns the parallelogram's bottom-right position as a Point.

bool	operator== (const Parallelogram &other) const noexcept
	Returns true if the two parallelograms are identical.

bool	operator!= (const Parallelogram &other) const noexcept
	Returns true if the two parallelograms are not identical.

Parallelogram	operator+ (Point< ValueType > deltaPosition) const noexcept
	Returns a parallelogram which is the same as this one moved by a given amount.

Parallelogram &	operator+= (Point< ValueType > deltaPosition) noexcept
	Moves this parallelogram by a given amount.

Parallelogram	operator- (Point< ValueType > deltaPosition) const noexcept
	Returns a parallelogram which is the same as this one moved by a given amount.

Parallelogram &	operator-= (Point< ValueType > deltaPosition) noexcept
	Moves this parallelogram by a given amount.

template<typename PointOrScalarType >
Parallelogram	operator* (PointOrScalarType scaleFactor) const noexcept
	Returns a parallelogram that has been scaled by the given amount, centred around the origin.

template<typename PointOrScalarType >
Parallelogram	operator*= (PointOrScalarType scaleFactor) noexcept
	Scales this parallelogram by the given amount, centred around the origin.

Point< ValueType >	getRelativePoint (Point< ValueType > relativePosition) const noexcept
	Returns a point within this parallelogram, specified as proportional coordinates.

Parallelogram	transformedBy (const AffineTransform &transform) const noexcept
	Returns a transformed version of the parallelogram.

Rectangle< ValueType >	getBoundingBox () const noexcept
	Returns the smallest rectangle that encloses this parallelogram.

Public Attributes
Point< ValueType >	topLeft

Point< ValueType >	topRight

Point< ValueType >	bottomLeft

Detailed Description

template<typename ValueType>
class juce::Parallelogram< ValueType >

Represents a parallelogram that is defined by 3 points.

See also: Rectangle, Point, Line

@tags{Graphics}

Definition at line 37 of file juce_Parallelogram.h.

Constructor & Destructor Documentation

◆ Parallelogram() [1/2]

template<typename ValueType >

juce::Parallelogram< ValueType >::Parallelogram	(	Point< ValueType >	topLeftPosition,
		Point< ValueType >	topRightPosition,
		Point< ValueType >	bottomLeftPosition
	)

noexcept

Creates a parallelogram based on 3 points.

Definition at line 49 of file juce_Parallelogram.h.

◆ Parallelogram() [2/2]

template<typename ValueType >

juce::Parallelogram< ValueType >::Parallelogram ( Rectangle< ValueType > rectangle )

noexcept

Creates a parallelogram from a rectangle.

Definition at line 57 of file juce_Parallelogram.h.

Member Function Documentation

◆ getBottomLeft()

template<typename ValueType >

Point< ValueType > juce::Parallelogram< ValueType >::getBottomLeft ( ) const

noexcept

Returns the parallelogram's bottom-left position as a Point.

Definition at line 90 of file juce_Parallelogram.h.

◆ getBottomRight()

template<typename ValueType >

Point< ValueType > juce::Parallelogram< ValueType >::getBottomRight ( ) const

noexcept

Returns the parallelogram's bottom-right position as a Point.

Definition at line 93 of file juce_Parallelogram.h.

◆ getBoundingBox()

template<typename ValueType >

Rectangle< ValueType > juce::Parallelogram< ValueType >::getBoundingBox ( ) const

noexcept

Returns the smallest rectangle that encloses this parallelogram.

Definition at line 176 of file juce_Parallelogram.h.

◆ getHeight()

template<typename ValueType >

ValueType juce::Parallelogram< ValueType >::getHeight ( ) const

noexcept

Returns the height of the parallelogram (i.e.

the straight-line distance between the top-left and bottom-left.

Definition at line 80 of file juce_Parallelogram.h.

◆ getRelativePoint()

template<typename ValueType >

Point< ValueType > juce::Parallelogram< ValueType >::getRelativePoint ( Point< ValueType > relativePosition ) const

noexcept

Returns a point within this parallelogram, specified as proportional coordinates.

The relative X and Y values should be between 0 and 1, where 0 is the left or top of this parallelogram, and 1 is the right or bottom. (Out-of-bounds values will return a point outside the parallelogram).

Definition at line 157 of file juce_Parallelogram.h.

◆ getTopLeft()

template<typename ValueType >

Point< ValueType > juce::Parallelogram< ValueType >::getTopLeft ( ) const

noexcept

Returns the parallelogram's top-left position as a Point.

Definition at line 84 of file juce_Parallelogram.h.

◆ getTopRight()

template<typename ValueType >

Point< ValueType > juce::Parallelogram< ValueType >::getTopRight ( ) const

noexcept

Returns the parallelogram's top-right position as a Point.

Definition at line 87 of file juce_Parallelogram.h.

◆ getWidth()

template<typename ValueType >

ValueType juce::Parallelogram< ValueType >::getWidth ( ) const

noexcept

Returns the width of the parallelogram (i.e.

the straight-line distance between the top-left and top-right.

Definition at line 77 of file juce_Parallelogram.h.

◆ isEmpty()

template<typename ValueType >

bool juce::Parallelogram< ValueType >::isEmpty ( ) const

noexcept

Returns true if the parallelogram has a width or height of more than zero.

Definition at line 71 of file juce_Parallelogram.h.

◆ isFinite()

template<typename ValueType >

bool juce::Parallelogram< ValueType >::isFinite ( ) const

noexcept

Returns true if the parallelogram's coordinates are all finite numbers, i.e.

not NaN or infinity.

Definition at line 74 of file juce_Parallelogram.h.

◆ operator!=()

template<typename ValueType >

bool juce::Parallelogram< ValueType >::operator!= ( const Parallelogram< ValueType > & other ) const

noexcept

Returns true if the two parallelograms are not identical.

Definition at line 100 of file juce_Parallelogram.h.

◆ operator*()

template<typename ValueType >

template<typename PointOrScalarType >

Parallelogram juce::Parallelogram< ValueType >::operator* ( PointOrScalarType scaleFactor ) const

noexcept

Returns a parallelogram that has been scaled by the given amount, centred around the origin.

Definition at line 134 of file juce_Parallelogram.h.

◆ operator*=()

template<typename ValueType >

template<typename PointOrScalarType >

Parallelogram juce::Parallelogram< ValueType >::operator*= ( PointOrScalarType scaleFactor )

noexcept

Scales this parallelogram by the given amount, centred around the origin.

Definition at line 143 of file juce_Parallelogram.h.

◆ operator+()

template<typename ValueType >

Parallelogram juce::Parallelogram< ValueType >::operator+ ( Point< ValueType > deltaPosition ) const

noexcept

Returns a parallelogram which is the same as this one moved by a given amount.

Definition at line 104 of file juce_Parallelogram.h.

◆ operator+=()

template<typename ValueType >

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

noexcept

Moves this parallelogram by a given amount.

Definition at line 112 of file juce_Parallelogram.h.

◆ operator-()

template<typename ValueType >

Parallelogram juce::Parallelogram< ValueType >::operator- ( Point< ValueType > deltaPosition ) const

noexcept

Returns a parallelogram which is the same as this one moved by a given amount.

Definition at line 121 of file juce_Parallelogram.h.

◆ operator-=()

template<typename ValueType >

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

noexcept

Moves this parallelogram by a given amount.

Definition at line 127 of file juce_Parallelogram.h.

◆ operator==()

template<typename ValueType >

bool juce::Parallelogram< ValueType >::operator== ( const Parallelogram< ValueType > & other ) const

noexcept

Returns true if the two parallelograms are identical.

Definition at line 97 of file juce_Parallelogram.h.

◆ transformedBy()

template<typename ValueType >

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

noexcept

Returns a transformed version of the parallelogram.

Definition at line 165 of file juce_Parallelogram.h.

Member Data Documentation

◆ bottomLeft

template<typename ValueType >

Point<ValueType> juce::Parallelogram< ValueType >::bottomLeft

Definition at line 182 of file juce_Parallelogram.h.

◆ topLeft

template<typename ValueType >

Point<ValueType> juce::Parallelogram< ValueType >::topLeft

Definition at line 182 of file juce_Parallelogram.h.

◆ topRight

template<typename ValueType >

Point<ValueType> juce::Parallelogram< ValueType >::topRight

Definition at line 182 of file juce_Parallelogram.h.

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

juce_graphics/geometry/juce_Parallelogram.h

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Parallelogram() [1/2]

◆ Parallelogram() [2/2]

Member Function Documentation

◆ getBottomLeft()

◆ getBottomRight()

◆ getBoundingBox()

◆ getHeight()

◆ getRelativePoint()

◆ getTopLeft()

◆ getTopRight()

◆ getWidth()

◆ isEmpty()

◆ isFinite()

◆ operator!=()

◆ operator*()

◆ operator*=()

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator==()

◆ transformedBy()

Member Data Documentation

◆ bottomLeft

◆ topLeft

◆ topRight