|
JUCE
|
Represents a line. More...
Public Member Functions | |
| Line () noexcept | |
| Creates a line, using (0, 0) as its start and end points. More... | |
| Line (const Line &other) noexcept | |
| Creates a copy of another line. More... | |
| Line (ValueType startX, ValueType startY, ValueType endX, ValueType endY) noexcept | |
| Creates a line based on the coordinates of its start and end points. More... | |
| Line (const Point< ValueType > startPoint, const Point< ValueType > endPoint) noexcept | |
| Creates a line from its start and end points. More... | |
| Line & | operator= (const Line &other) noexcept |
| Copies a line from another one. More... | |
| ~Line () noexcept | |
| Destructor. More... | |
| ValueType | getStartX () const noexcept |
| Returns the x coordinate of the line's start point. More... | |
| ValueType | getStartY () const noexcept |
| Returns the y coordinate of the line's start point. More... | |
| ValueType | getEndX () const noexcept |
| Returns the x coordinate of the line's end point. More... | |
| ValueType | getEndY () const noexcept |
| Returns the y coordinate of the line's end point. More... | |
| Point< ValueType > | getStart () const noexcept |
| Returns the line's start point. More... | |
| Point< ValueType > | getEnd () const noexcept |
| Returns the line's end point. More... | |
| void | setStart (ValueType newStartX, ValueType newStartY) noexcept |
| Changes this line's start point. More... | |
| void | setEnd (ValueType newEndX, ValueType newEndY) noexcept |
| Changes this line's end point. More... | |
| void | setStart (const Point< ValueType > newStart) noexcept |
| Changes this line's start point. More... | |
| void | setEnd (const Point< ValueType > newEnd) noexcept |
| Changes this line's end point. More... | |
| const Line | reversed () const noexcept |
| Returns a line that is the same as this one, but with the start and end reversed,. More... | |
| void | applyTransform (const AffineTransform &transform) noexcept |
| Applies an affine transform to the line's start and end points. More... | |
| ValueType | getLength () const noexcept |
| Returns the length of the line. More... | |
| ValueType | getLengthSquared () const noexcept |
| Returns the length of the line. More... | |
| bool | isVertical () const noexcept |
| Returns true if the line's start and end x coordinates are the same. More... | |
| bool | isHorizontal () const noexcept |
| Returns true if the line's start and end y coordinates are the same. More... | |
| Point< ValueType >::FloatType | getAngle () const noexcept |
| Returns the line's angle. More... | |
| Line< float > | toFloat () const noexcept |
| Casts this line to float coordinates. More... | |
| Line< double > | toDouble () const noexcept |
| Casts this line to double coordinates. More... | |
| bool | operator== (const Line &other) const noexcept |
| Compares two lines. More... | |
| bool | operator!= (const Line &other) const noexcept |
| Compares two lines. More... | |
| Point< ValueType > | getIntersection (const Line &line) const noexcept |
| Finds the intersection between two lines. More... | |
| bool | intersects (const Line &line, Point< ValueType > &intersection) const noexcept |
| Finds the intersection between two lines. More... | |
| bool | intersects (const Line &other) const noexcept |
| Returns true if this line intersects another. More... | |
| Point< ValueType > | getPointAlongLine (ValueType distanceFromStart) const noexcept |
| Returns the location of the point which is a given distance along this line. More... | |
| Point< ValueType > | getPointAlongLine (ValueType distanceFromStart, ValueType perpendicularDistance) const noexcept |
| Returns a point which is a certain distance along and to the side of this line. More... | |
| Point< ValueType > | getPointAlongLineProportionally (ValueType proportionOfLength) const noexcept |
| Returns the location of the point which is a given distance along this line proportional to the line's length. More... | |
| ValueType | getDistanceFromPoint (const Point< ValueType > targetPoint, Point< ValueType > &pointOnLine) const noexcept |
| Returns the smallest distance between this line segment and a given point. More... | |
| ValueType | findNearestProportionalPositionTo (const Point< ValueType > point) const noexcept |
| Finds the point on this line which is nearest to a given point, and returns its position as a proportional position along the line. More... | |
| Point< ValueType > | findNearestPointTo (const Point< ValueType > point) const noexcept |
| Finds the point on this line which is nearest to a given point. More... | |
| bool | isPointAbove (const Point< ValueType > point) const noexcept |
| Returns true if the given point lies above this line. More... | |
| Line | withShortenedStart (ValueType distanceToShortenBy) const noexcept |
| Returns a shortened copy of this line. More... | |
| Line | withShortenedEnd (ValueType distanceToShortenBy) const noexcept |
| Returns a shortened copy of this line. More... | |
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.
Creates a line, using (0, 0) as its start and end points.
Referenced by Line< ValueType >::reversed(), Line< ValueType >::withShortenedEnd(), and Line< ValueType >::withShortenedStart().
Creates a copy of another line.
|
noexcept |
Creates a line based on the coordinates of its start and end points.
|
noexcept |
Creates a line from its start and end points.
|
noexcept |
Copies a line from another one.
|
noexcept |
Returns the x coordinate of the line's start point.
|
noexcept |
Returns the y coordinate of the line's start point.
|
noexcept |
Returns the x coordinate of the line's end point.
|
noexcept |
Returns the y coordinate of the line's end point.
Returns the line's start point.
Returns the line's end point.
|
noexcept |
Changes this line's start point.
|
noexcept |
Changes this line's end point.
|
noexcept |
Changes this line's start point.
|
noexcept |
Changes this line's end point.
Returns a line that is the same as this one, but with the start and end reversed,.
References Line< ValueType >::Line().
|
noexcept |
Applies an affine transform to the line's start and end points.
|
noexcept |
Returns the length of the line.
Referenced by Line< ValueType >::getPointAlongLine(), Line< ValueType >::withShortenedEnd(), and Line< ValueType >::withShortenedStart().
|
noexcept |
Returns the length of the line.
|
noexcept |
Returns true if the line's start and end x coordinates are the same.
|
noexcept |
Returns true if the line's start and end y coordinates are the same.
|
noexcept |
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.
Casts this line to float coordinates.
Casts this line to double coordinates.
|
noexcept |
Compares two lines.
|
noexcept |
Compares two lines.
|
noexcept |
Finds the intersection between two lines.
| line | the line to intersect with |
|
noexcept |
Finds the intersection between two lines.
| 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. |
|
noexcept |
Returns true if this line intersects another.
|
noexcept |
Returns the location of the point which is a given distance along this line.
| distanceFromStart | the distance to move along the line from its start point. This value can be negative or longer than the line itself |
References Line< ValueType >::getLength().
Referenced by Line< ValueType >::withShortenedEnd(), and Line< ValueType >::withShortenedStart().
|
noexcept |
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.
| 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. |
References juce_hypot(), Point< ValueType >::x, and Point< ValueType >::y.
|
noexcept |
Returns the location of the point which is a given distance along this line proportional to the line's length.
| 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). |
Referenced by Line< ValueType >::findNearestPointTo().
|
noexcept |
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.
References Point< ValueType >::getDistanceFrom(), Point< ValueType >::x, and Point< ValueType >::y.
|
noexcept |
Finds the point on this line which is nearest to a given point, and returns its position as a proportional position along the line.
References jlimit(), Point< ValueType >::x, and Point< ValueType >::y.
Referenced by Line< ValueType >::findNearestPointTo().
|
noexcept |
Finds the point on this line which is nearest to a given point.
References Line< ValueType >::findNearestProportionalPositionTo(), and Line< ValueType >::getPointAlongLineProportionally().
|
noexcept |
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).
|
noexcept |
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.
References Line< ValueType >::getLength(), Line< ValueType >::getPointAlongLine(), jmin(), and Line< ValueType >::Line().
|
noexcept |
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.
References Line< ValueType >::getLength(), Line< ValueType >::getPointAlongLine(), Point< ValueType >::isOrigin(), jmin(), Line< ValueType >::Line(), Point< ValueType >::withX(), Point< ValueType >::withY(), Point< ValueType >::x, and Point< ValueType >::y.
