juce::Line< ValueType > Class Template Reference

#include <juce_Line.h>

Public Member Functions
	Line ()=default
	Line (const Line &)=default
	Line (ValueType startX, ValueType startY, ValueType endX, ValueType endY) noexcept
	Line (Point< ValueType > startPoint, Point< ValueType > endPoint) noexcept
Line &	operator= (const Line &)=default
	~Line ()=default
ValueType	getStartX () const noexcept
ValueType	getStartY () const noexcept
ValueType	getEndX () const noexcept
ValueType	getEndY () const noexcept
Point< ValueType >	getStart () const noexcept
Point< ValueType >	getEnd () const noexcept
void	setStart (ValueType newStartX, ValueType newStartY) noexcept
void	setEnd (ValueType newEndX, ValueType newEndY) noexcept
void	setStart (const Point< ValueType > newStart) noexcept
void	setEnd (const Point< ValueType > newEnd) noexcept
Line	reversed () const noexcept
void	applyTransform (const AffineTransform &transform) noexcept
ValueType	getLength () const noexcept
ValueType	getLengthSquared () const noexcept
bool	isVertical () const noexcept
bool	isHorizontal () const noexcept
Point< ValueType >::FloatType	getAngle () const noexcept
Line< float >	toFloat () const noexcept
Line< double >	toDouble () const noexcept
bool	operator== (Line other) const noexcept
bool	operator!= (Line other) const noexcept
Point< ValueType >	getIntersection (Line line) const noexcept
bool	intersects (Line line, Point< ValueType > &intersection) const noexcept
bool	intersects (Line other) const noexcept
Point< ValueType >	getPointAlongLine (ValueType distanceFromStart) const noexcept
Point< ValueType >	getPointAlongLine (ValueType distanceFromStart, ValueType perpendicularDistance) const noexcept
Point< ValueType >	getPointAlongLineProportionally (typename Point< ValueType >::FloatType proportionOfLength) const noexcept
ValueType	getDistanceFromPoint (Point< ValueType > targetPoint, Point< ValueType > &pointOnLine) const noexcept
ValueType	findNearestProportionalPositionTo (Point< ValueType > point) const noexcept
Point< ValueType >	findNearestPointTo (Point< ValueType > point) const noexcept
bool	isPointAbove (Point< ValueType > point) const noexcept
Line	withLengthenedStart (ValueType distanceToLengthenBy) const noexcept
Line	withShortenedStart (ValueType distanceToShortenBy) const noexcept
Line	withLengthenedEnd (ValueType distanceToLengthenBy) const noexcept
Line	withShortenedEnd (ValueType distanceToShortenBy) const noexcept

Static Public Member Functions
static Line	fromStartAndAngle (Point< ValueType > startPoint, ValueType length, ValueType angle) noexcept

Static Private Member Functions
static bool	isZeroToOne (ValueType v) noexcept
static bool	findIntersection (const Point< ValueType > p1, const Point< ValueType > p2, const Point< ValueType > p3, const Point< ValueType > p4, Point< ValueType > &intersection) noexcept

Private Attributes
Point< ValueType >	start
Point< ValueType >	end

Detailed Description

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

Represents a line.

This class contains a bunch of useful methods for various geometric tasks.

The ValueType template parameter should be a primitive type - float or double are what it's designed for. Integer types will work in a basic way, but some methods that perform mathematical operations may not compile, or they may not produce sensible results.

See also

Point, Rectangle, Path, Graphics::drawLine

@tags{Graphics}

Constructor & Destructor Documentation

Line() [1/4]

template<typename ValueType>

Line::Line ( )

defaultnoexcept

Creates a line, using (0, 0) as its start and end points.

Line() [2/4]

template<typename ValueType>

juce::Line< ValueType >::Line ( const Line< ValueType > & )

default

Creates a copy of another line.

Line() [3/4]

template<typename ValueType>

juce::Line< ValueType >::Line ( ValueType startX, ValueType startY, ValueType endX, ValueType endY )

inlinenoexcept

Creates a line based on the coordinates of its start and end points.

Line() [4/4]

template<typename ValueType>

juce::Line< ValueType >::Line ( Point< ValueType > startPoint, Point< ValueType > endPoint )

inlinenoexcept

Creates a line from its start and end points.

~Line()

template<typename ValueType>

juce::Line< ValueType >::~Line ( )

default

Destructor.

Member Function Documentation

applyTransform()

template<typename ValueType>

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

inlinenoexcept

Applies an affine transform to the line's start and end points.

findIntersection()

template<typename ValueType>

bool juce::Line< ValueType >::findIntersection ( const Point< ValueType > p1, const Point< ValueType > p2, const Point< ValueType > p3, const Point< ValueType > p4, Point< ValueType > & intersection )

inlinestaticprivatenoexcept

findNearestPointTo()

template<typename ValueType>

Point< ValueType > juce::Line< ValueType >::findNearestPointTo ( Point< ValueType > point ) const

inlinenoexcept

Finds the point on this line which is nearest to a given point.

See also

getDistanceFromPoint, findNearestProportionalPositionTo

findNearestProportionalPositionTo()

template<typename ValueType>

ValueType juce::Line< ValueType >::findNearestProportionalPositionTo ( Point< ValueType > point ) const

inlinenoexcept

Finds the point on this line which is nearest to a given point, and returns its position as a proportional position along the line.

Returns

a value 0 to 1.0 which is the distance along this line from the line's start to the point which is nearest to the point passed-in. To turn this number into a position, use getPointAlongLineProportionally().

See also

getDistanceFromPoint, getPointAlongLineProportionally

fromStartAndAngle()

template<typename ValueType>

Line juce::Line< ValueType >::fromStartAndAngle ( Point< ValueType > startPoint, ValueType length, ValueType angle )

inlinestaticnoexcept

Creates a line from a start point, length and angle.

This angle is the number of radians clockwise from the 12 o'clock direction, where the line's start point is considered to be at the centre.

getAngle()

template<typename ValueType>

Point< ValueType >::FloatType juce::Line< ValueType >::getAngle ( ) const

inlinenoexcept

Returns the line's angle.

This value is the number of radians clockwise from the 12 o'clock direction, where the line's start point is considered to be at the centre.

getDistanceFromPoint()

template<typename ValueType>

ValueType juce::Line< ValueType >::getDistanceFromPoint ( Point< ValueType > targetPoint, Point< ValueType > & pointOnLine ) const

inlinenoexcept

Returns the smallest distance between this line segment and a given point.

So if the point is close to the line, this will return the perpendicular distance from the line; if the point is a long way beyond one of the line's end-point's, it'll return the straight-line distance to the nearest end-point.

pointOnLine receives the position of the point that is found.

Returns

the point's distance from the line

See also

getPositionAlongLineOfNearestPoint

getEnd()

template<typename ValueType>

Point< ValueType > juce::Line< ValueType >::getEnd ( ) const

inlinenoexcept

Returns the line's end point.

getEndX()

template<typename ValueType>

const T & Line::getEndX ( ) const

inlinenoexcept

Returns the x coordinate of the line's end point.

getEndY()

template<typename ValueType>

const T & Line::getEndY ( ) const

inlinenoexcept

Returns the y coordinate of the line's end point.

getIntersection()

template<typename ValueType>

Point< ValueType > juce::Line< ValueType >::getIntersection ( Line< ValueType > line ) const

inlinenoexcept

Finds the intersection between two lines.

Parameters

line	the line to intersect with

Returns

the point at which the lines intersect, even if this lies beyond the end of the lines

getLength()

template<typename ValueType>

ValueType juce::Line< ValueType >::getLength ( ) const

inlinenoexcept

Returns the length of the line.

getLengthSquared()

template<typename ValueType>

ValueType juce::Line< ValueType >::getLengthSquared ( ) const

inlinenoexcept

Returns the length of the line.

getPointAlongLine() [1/2]

template<typename ValueType>

Point< ValueType > juce::Line< ValueType >::getPointAlongLine ( ValueType distanceFromStart ) const

inlinenoexcept

Returns the location of the point which is a given distance along this line.

Parameters

distanceFromStart

the distance to move along the line from its start point. This value can be negative or longer than the line itself

See also

getPointAlongLineProportionally

getPointAlongLine() [2/2]

template<typename ValueType>

Point< ValueType > juce::Line< ValueType >::getPointAlongLine ( ValueType distanceFromStart, ValueType perpendicularDistance ) const

inlinenoexcept

Returns a point which is a certain distance along and to the side of this line.

This effectively moves a given distance along the line, then another distance perpendicularly to this, and returns the resulting position.

Parameters

distanceFromStart	the distance to move along the line from its start point. This value can be negative or longer than the line itself
perpendicularDistance	how far to move sideways from the line. If you're looking along the line from its start towards its end, then a positive value here will move to the right, negative value move to the left.

getPointAlongLineProportionally()

template<typename ValueType>

Point< ValueType > juce::Line< ValueType >::getPointAlongLineProportionally ( typename Point< ValueType >::FloatType proportionOfLength ) const

inlinenoexcept

Returns the location of the point which is a given distance along this line proportional to the line's length.

Parameters

proportionOfLength

the distance to move along the line from its start point, in multiples of the line's length. So a value of 0.0 will return the line's start point and a value of 1.0 will return its end point. (This value can be negative or greater than 1.0).

See also

getPointAlongLine

getStart()

template<typename ValueType>

Point< ValueType > juce::Line< ValueType >::getStart ( ) const

inlinenoexcept

Returns the line's start point.

getStartX()

template<typename ValueType>

const T & Line::getStartX ( ) const

inlinenoexcept

Returns the x coordinate of the line's start point.

getStartY()

template<typename ValueType>

const T & Line::getStartY ( ) const

inlinenoexcept

Returns the y coordinate of the line's start point.

intersects() [1/2]

template<typename ValueType>

bool juce::Line< ValueType >::intersects ( Line< ValueType > line, Point< ValueType > & intersection ) const

inlinenoexcept

Finds the intersection between two lines.

Parameters

line	the other line
intersection	the position of the point where the lines meet (or where they would meet if they were infinitely long) the intersection (if the lines intersect). If the lines are parallel, this will just be set to the position of one of the line's endpoints.

Returns

true if the line segments intersect; false if they don't. Even if they don't intersect, the intersection coordinates returned will still be valid

intersects() [2/2]

template<typename ValueType>

bool juce::Line< ValueType >::intersects ( Line< ValueType > other ) const

inlinenoexcept

Returns true if this line intersects another.

isHorizontal()

template<typename ValueType>

bool juce::Line< ValueType >::isHorizontal ( ) const

inlinenoexcept

Returns true if the line's start and end y coordinates are the same.

isPointAbove()

template<typename ValueType>

bool juce::Line< ValueType >::isPointAbove ( Point< ValueType > point ) const

inlinenoexcept

Returns true if the given point lies above this line.

The return value is true if the point's y coordinate is less than the y coordinate of this line at the given x (assuming the line extends infinitely in both directions).

isVertical()

template<typename ValueType>

bool juce::Line< ValueType >::isVertical ( ) const

inlinenoexcept

Returns true if the line's start and end x coordinates are the same.

isZeroToOne()

template<typename ValueType>

bool juce::Line< ValueType >::isZeroToOne ( ValueType v )

inlinestaticprivatenoexcept

operator!=()

template<typename ValueType>

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

inlinenoexcept

Compares two lines.

operator=()

template<typename ValueType>

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

default

Copies a line from another one.

operator==()

template<typename ValueType>

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

inlinenoexcept

Compares two lines.

reversed()

template<typename ValueType>

Line juce::Line< ValueType >::reversed ( ) const

inlinenoexcept

Returns a line that is the same as this one, but with the start and end reversed,

setEnd() [1/2]

template<typename ValueType>

void juce::Line< ValueType >::setEnd ( const Point< ValueType > newEnd )

inlinenoexcept

Changes this line's end point

setEnd() [2/2]

template<typename ValueType>

void juce::Line< ValueType >::setEnd ( ValueType newEndX, ValueType newEndY )

inlinenoexcept

Changes this line's end point

setStart() [1/2]

template<typename ValueType>

void juce::Line< ValueType >::setStart ( const Point< ValueType > newStart )

inlinenoexcept

Changes this line's start point

setStart() [2/2]

template<typename ValueType>

void juce::Line< ValueType >::setStart ( ValueType newStartX, ValueType newStartY )

inlinenoexcept

Changes this line's start point

toDouble()

template<typename ValueType>

Line< double > juce::Line< ValueType >::toDouble ( ) const

inlinenoexcept

Casts this line to double coordinates.

toFloat()

template<typename ValueType>

Line< float > juce::Line< ValueType >::toFloat ( ) const

inlinenoexcept

Casts this line to float coordinates.

withLengthenedEnd()

template<typename ValueType>

Line juce::Line< ValueType >::withLengthenedEnd ( ValueType distanceToLengthenBy ) const

inlinenoexcept

Returns a lengthened copy of this line.

This will extend the line by a certain amount by moving the end away from the start (leaving the start-point the same), and return the new line.

withLengthenedStart()

template<typename ValueType>

Line juce::Line< ValueType >::withLengthenedStart ( ValueType distanceToLengthenBy ) const

inlinenoexcept

Returns a lengthened copy of this line.

This will extend the line by a certain amount by moving the start away from the end (leaving the end-point the same), and return the new line.

withShortenedEnd()

template<typename ValueType>

Line juce::Line< ValueType >::withShortenedEnd ( ValueType distanceToShortenBy ) const

inlinenoexcept

Returns a shortened copy of this line.

This will chop off part of the end of this line by a certain amount, (leaving the start-point the same), and return the new line.

withShortenedStart()

template<typename ValueType>

Line juce::Line< ValueType >::withShortenedStart ( ValueType distanceToShortenBy ) const

inlinenoexcept

Returns a shortened copy of this line.

This will chop off part of the start of this line by a certain amount, (leaving the end-point the same), and return the new line.

Member Data Documentation

end

template<typename ValueType>

Point<ValueType> juce::Line< ValueType >::end

private

start

template<typename ValueType>

Point<ValueType> juce::Line< ValueType >::start

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_graphics/geometry/juce_Line.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/dgl/src/Geometry.cpp