public class LineSegment extends Object implements Comparable, Serializable
Coordinate
s.
Provides methods to compute various geometric properties
and relationships of line segments.
This class is designed to be easily mutable (to the extent of
having its contained points public).
This supports a common pattern of reusing a single LineSegment
object as a way of computing segment properties on the
segments defined by arrays or lists of Coordinate
s.
Modifier and Type  Field and Description 

Coordinate 
p0 
Coordinate 
p1 
Constructor and Description 

LineSegment() 
LineSegment(Coordinate p0,
Coordinate p1) 
LineSegment(double x0,
double y0,
double x1,
double y1) 
LineSegment(LineSegment ls) 
Modifier and Type  Method and Description 

double 
angle()
Computes the angle that the vector defined by this segment
makes with the Xaxis.

Coordinate 
closestPoint(Coordinate p)
Computes the closest point on this line segment to another point.

Coordinate[] 
closestPoints(LineSegment line)
Computes the closest points on two line segments.

int 
compareTo(Object o)
Compares this object with the specified object for order.

double 
distance(Coordinate p)
Computes the distance between this line segment and a given point.

double 
distance(LineSegment ls)
Computes the distance between this line segment and another segment.

double 
distancePerpendicular(Coordinate p)
Computes the perpendicular distance between the (infinite) line defined
by this line segment and a point.

boolean 
equals(Object o)
Returns
true if other has the same values for
its points. 
boolean 
equalsTopo(LineSegment other)
Returns
true if other is
topologically equal to this LineSegment (e.g. 
Coordinate 
getCoordinate(int i) 
double 
getLength()
Computes the length of the line segment.

int 
hashCode()
Gets a hashcode for this object.

Coordinate 
intersection(LineSegment line)
Computes an intersection point between two line segments, if there is one.

boolean 
isHorizontal()
Tests whether the segment is horizontal.

boolean 
isVertical()
Tests whether the segment is vertical.

Coordinate 
lineIntersection(LineSegment line)
Computes the intersection point of the lines of infinite extent defined
by two line segments (if there is one).

double 
maxX()
Gets the maximum X ordinate.

double 
maxY()
Gets the maximum Y ordinate.

Coordinate 
midPoint()
Computes the midpoint of the segment

static Coordinate 
midPoint(Coordinate p0,
Coordinate p1)
Computes the midpoint of a segment

double 
minX()
Gets the minimum X ordinate.

double 
minY()
Gets the minimum Y ordinate.

void 
normalize()
Puts the line segment into a normalized form.

LineSegment 
offset(double offsetDistance)
Computes the
LineSegment that is offset from
the segment by a given distance. 
int 
OLDhashCode() 
int 
orientationIndex(Coordinate p)
Determines the orientation index of a
Coordinate relative to this segment. 
int 
orientationIndex(LineSegment seg)
Determines the orientation of a LineSegment relative to this segment.

Coordinate 
pointAlong(double segmentLengthFraction)
Computes the
Coordinate that lies a given
fraction along the line defined by this segment. 
Coordinate 
pointAlongOffset(double segmentLengthFraction,
double offsetDistance)
Computes the
Coordinate that lies a given
fraction along the line defined by this segment and offset from
the segment by a given distance. 
Coordinate 
project(Coordinate p)
Compute the projection of a point onto the line determined
by this line segment.

LineSegment 
project(LineSegment seg)
Project a line segment onto this line segment and return the resulting
line segment.

double 
projectionFactor(Coordinate p)
Computes the Projection Factor for the projection of the point p
onto this LineSegment.

Coordinate 
reflect(Coordinate p)
Computes the reflection of a point in the line defined
by this line segment.

void 
reverse()
Reverses the direction of the line segment.

double 
segmentFraction(Coordinate inputPt)
Computes the fraction of distance (in [0.0, 1.0])
that the projection of a point occurs along this line segment.

void 
setCoordinates(Coordinate p0,
Coordinate p1) 
void 
setCoordinates(LineSegment ls) 
LineString 
toGeometry(GeometryFactory geomFactory)
Creates a LineString with the same coordinates as this segment

String 
toString() 
public Coordinate p0
public Coordinate p1
public LineSegment(Coordinate p0, Coordinate p1)
public LineSegment(double x0, double y0, double x1, double y1)
public LineSegment(LineSegment ls)
public LineSegment()
public Coordinate getCoordinate(int i)
public void setCoordinates(LineSegment ls)
public void setCoordinates(Coordinate p0, Coordinate p1)
public double minX()
public double maxX()
public double minY()
public double maxY()
public double getLength()
public boolean isHorizontal()
true
if the segment is horizontalpublic boolean isVertical()
true
if the segment is verticalpublic int orientationIndex(LineSegment seg)
seg
 the LineSegment to compareseg
is to the left of this segmentpublic int orientationIndex(Coordinate p)
Coordinate
relative to this segment.
The orientation index is as defined in Orientation.index(Coordinate, Coordinate, Coordinate)
.p
 the coordinate to comparep
is to the left of this segmentOrientation.index(Coordinate, Coordinate, Coordinate)
public void reverse()
public void normalize()
Coordinate
).public double angle()
public Coordinate midPoint()
public static Coordinate midPoint(Coordinate p0, Coordinate p1)
public double distance(LineSegment ls)
public double distance(Coordinate p)
public double distancePerpendicular(Coordinate p)
public Coordinate pointAlong(double segmentLengthFraction)
Coordinate
that lies a given
fraction along the line defined by this segment.
A fraction of 0.0
returns the start point of the segment;
a fraction of 1.0
returns the end point of the segment.
If the fraction is < 0.0 or > 1.0 the point returned
will lie before the start or beyond the end of the segment.segmentLengthFraction
 the fraction of the segment length along the linepublic Coordinate pointAlongOffset(double segmentLengthFraction, double offsetDistance)
Coordinate
that lies a given
fraction along the line defined by this segment and offset from
the segment by a given distance.
A fraction of 0.0
offsets from the start point of the segment;
a fraction of 1.0
offsets from the end point of the segment.
The computed point is offset to the left of the line if the offset distance is
positive, to the right if negative.segmentLengthFraction
 the fraction of the segment length along the lineoffsetDistance
 the distance the point is offset from the segment
(positive is to the left, negative is to the right)IllegalStateException
 if the segment has zero lengthpublic double projectionFactor(Coordinate p)
The projection factor will lie in the range (inf, +inf),
or be NaN
if the line segment has zero length..
p
 the point to compute the factor forpublic double segmentFraction(Coordinate inputPt)
Essentially, this is the projectionFactor(org.locationtech.jts.geom.Coordinate)
clamped to
the range [0.0, 1.0].
If the segment has zero length, 1.0 is returned.
inputPt
 the pointpublic Coordinate project(Coordinate p)
Note that the projected point may lie outside the line segment. If this is the case, the projection factor will lie outside the range [0.0, 1.0].
public LineSegment project(LineSegment seg)
Note that the returned line may have zero length (i.e. the same endpoints). This can happen for instance if the lines are perpendicular to one another.
seg
 the line segment to projectnull
if there is no overlappublic LineSegment offset(double offsetDistance)
LineSegment
that is offset from
the segment by a given distance.
The computed segment is offset to the left of the line if the offset distance is
positive, to the right if negative.offsetDistance
 the distance the point is offset from the segment
(positive is to the left, negative is to the right)IllegalStateException
 if the segment has zero lengthpublic Coordinate reflect(Coordinate p)
p
 the point to reflectpublic Coordinate closestPoint(Coordinate p)
p
 the point to find the closest point topublic Coordinate[] closestPoints(LineSegment line)
line
 the segment to find the closest point topublic Coordinate intersection(LineSegment line)
RobustLineIntersector
class should be used.line
 a line segmentnull
if there is noneRobustLineIntersector
public Coordinate lineIntersection(LineSegment line)
RobustLineIntersector
class should be used.line
 a line segment defining an straight line with infinite extentnull
if there is no point of intersection
or an infinite number of intersection pointsRobustLineIntersector
public LineString toGeometry(GeometryFactory geomFactory)
geomFactory
 the geometry factory to usepublic boolean equals(Object o)
true
if other
has the same values for
its points.public int hashCode()
public int OLDhashCode()
public int compareTo(Object o)
compareTo
in interface Comparable
o
 the LineSegment
with which this LineSegment
is being comparedLineSegment
is less than, equal to, or greater than the specified LineSegment
public boolean equalsTopo(LineSegment other)
true
if other
is
topologically equal to this LineSegment (e.g. irrespective
of orientation).other
 a LineSegment
with which to do the comparison.true
if other
is a LineSegment
with the same values for the x and y ordinates.Copyright © 2022. All rights reserved.