execution.world.geometry

Class LineSegment

java.lang.Object

execution.world.geometry.Geometry

execution.world.geometry.LineSegment

All Implemented Interfaces:

Cloneable

public class LineSegment
extends Geometry
implements Cloneable

Class for representing a line segment in 2D space. Will always maintain the values so that "end1" has a lower (or equal) x value than "end2" MOVES Institute Naval Postgraduate School, Monterey, CA www.nps.edu

Since:

Apr 20, 2009, 1:27:31 PM

Version:

$Id: LineSegment.java 8086 2012-07-16 23:46:35Z tnorbraten $

Author:

Duane Davis

Constructor Summary

Constructors

Constructor and Description
LineSegment(double[] p1, double[] p2) Constructor
LineSegment(double x1, double y1, double x2, double y2) Constructor
LineSegment(LineSegment l2) Copy constructor
LineSegment(Point point1, Point point2) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
LineSegment	clone() Implements the Cloneable interface and makes an item-by-item copy
double	getDirectionTo(double x, double y) Computes the direction (radians) from this line segment to a specified point
double	getDirectionTo(double centerX, double centerY, double radius) Computes the direction (radians) from the Geometry object to a Circle
double	getDirectionTo(double x1, double y1, double x2, double y2) Computes the direction (radians) from this segment to the closest point on a line segment
double	getDistance(double x, double y) Computes the distance from this line segment to a Point
double	getDistance(double centerX, double centerY, double radius) Computes the distance from the Geometry object to a Circle
double	getDistance(double x1, double y1, double x2, double y2) Computes the distance between this line segment and another line segment
Point	getEnd1() Returns the first end point
Point	getEnd2() Returns the second end point
double[]	getIntersectPoint(double x1, double y1, double x2, double y2) Computes the point of intersection of the extended lines of this and another segment
void	setEnd1(double[] newEnd1) Sets the first end point of the segment
void	setEnd1(double newX, double newY) Sets the first end point of the segment
void	setEnd1(Point newEnd1) Sets the first end point of the segment
void	setEnd2(double[] newEnd) Sets the second end point of the segment
void	setEnd2(double newX, double newY) Resets the second end point of the segment
void	setEnd2(Point newEnd) Sets the second end point of the segment
void	setEnds(double[] p1, double[] p2) Sets both end points of the segment
void	setEnds(double x1, double y1, double x2, double y2) Sets both end points of the segment
void	setEnds(Point newEnd1, Point newEnd2) Sets both end points of the segment
String	toString() Generates a string representation of the LineSegment object

Methods inherited from class execution.world.geometry.Geometry

determinant, dotProduct, getClosestPointOnLine, getClosestPointOnSegment, getDirectionTo, getDirectionTo, getDirectionTo, getDirectionTo, getDirectionTo, getDirectionTo, getDirectionTo, getDistance, getDistance, getDistance, getDistance, getDistance, getDistance, getDistance, getDistance, getIntersectPoint, isInSegment, isOnSegment, pointDirection, pointDistance

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LineSegment

public LineSegment(Point point1,
           Point point2)

Constructor

Parameters:

point1 - one end point of the segment

point2 - second end point of the segment

LineSegment

public LineSegment(double[] p1,
           double[] p2)

Constructor

Parameters:

p1 - Cartesian coordinate of one end point of the segment

p2 - Cartesian coordinate of the second end point of the segment

LineSegment

public LineSegment(double x1,
           double y1,
           double x2,
           double y2)

Constructor

Parameters:

x1 - north/south Cartesian coordinate of one end point of the segment

y1 - east/west Cartesian coordinate of one end point of the segment

x2 - north/south Cartesian coordinate of the second end point of the segment

y2 - east/west Cartesian coordinate of the second end point of the segment

LineSegment

public LineSegment(LineSegment l2)

Copy constructor

Method Detail

clone

public LineSegment clone()

Implements the Cloneable interface and makes an item-by-item copy

Overrides:

clone in class Object

setEnds

public void setEnds(Point newEnd1,
           Point newEnd2)

Sets both end points of the segment

Parameters:

newEnd1 - new end point

newEnd2 - new end point

setEnds

public void setEnds(double[] p1,
           double[] p2)

Sets both end points of the segment

Parameters:

p1 - Cartesian coordinate of one end point of the segment

p2 - Cartesian coordinate of the second end point of the segment

setEnds

public void setEnds(double x1,
           double y1,
           double x2,
           double y2)

Sets both end points of the segment

Parameters:

x1 - north/south Cartesian coordinate of one end point of the segment

y1 - east/west Cartesian coordinate of one end point of the segment

x2 - north/south Cartesian coordinate of the second end point of the segment

y2 - east/west Cartesian coordinate of the second end point of the segment

setEnd1

public void setEnd1(Point newEnd1)

Sets the first end point of the segment

Parameters:

newEnd1 - new end point

setEnd1

public void setEnd1(double[] newEnd1)

Sets the first end point of the segment

Parameters:

newEnd1 - new end point

setEnd1

public void setEnd1(double newX,
           double newY)

Sets the first end point of the segment

Parameters:

newX - north/south coordinate of the new end point

newY - east/west coordinate of the new end point

getEnd1

public Point getEnd1()

Returns the first end point

Returns:

Cartesian point of the first segment end

setEnd2

public void setEnd2(Point newEnd)

Sets the second end point of the segment

Parameters:

newEnd - new end point

setEnd2

public void setEnd2(double[] newEnd)

Sets the second end point of the segment

Parameters:

newEnd - new end point

setEnd2

public void setEnd2(double newX,
           double newY)

Resets the second end point of the segment

Parameters:

newX - north/south coordinate of the new end point

newY - east/west coordinate of the new end point

getEnd2

public Point getEnd2()

Returns the second end point

Returns:

Cartesian point of the first segment end

getDistance

public double getDistance(double x,
                 double y)

Computes the distance from this line segment to a Point

Specified by:

getDistance in class Geometry

Parameters:

x - north/south coordinate of the point being tested

y - east/west coordinate of the point being tested

Returns:

the distance (meters) between this point and point2

getDirectionTo

public double getDirectionTo(double x,
                    double y)

Computes the direction (radians) from this line segment to a specified point

Specified by:

getDirectionTo in class Geometry

Parameters:

x - x coordinate of the point being tested

y - y coordinate of the point being tested

Returns:

the distance (meters) between this point and point2

getDistance

public double getDistance(double centerX,
                 double centerY,
                 double radius)

Computes the distance from the Geometry object to a Circle

Specified by:

getDistance in class Geometry

Parameters:

centerX - north/south coordinate of the circle being tested

centerY - east/west coordinate of the circle being tested

radius - of the circle being tested

Returns:

the distance (meters) between this point and point2

getDirectionTo

public double getDirectionTo(double centerX,
                    double centerY,
                    double radius)

Computes the direction (radians) from the Geometry object to a Circle

Specified by:

getDirectionTo in class Geometry

Parameters:

centerX - x coordinate of the circle being tested

centerY - y coordinate of the circle being tested

radius - of the circle being tested

Returns:

the direction from this Geometry object to a circle

getDistance

public double getDistance(double x1,
                 double y1,
                 double x2,
                 double y2)

Computes the distance between this line segment and another line segment

Specified by:

getDistance in class Geometry

Parameters:

x1 - north/south coordinate of the first segment end point

y1 - east west coordinate of the first segment end point

x2 - north/south coordinate of the second segment end point

y2 - east west coordinate of the second segment end point

Returns:

the distance (meters) between this point and point2

getDirectionTo

public double getDirectionTo(double x1,
                    double y1,
                    double x2,
                    double y2)

Computes the direction (radians) from this segment to the closest point on a line segment

Specified by:

getDirectionTo in class Geometry

Parameters:

x1 - north/south coordinate of the first segment end point

y1 - east west coordinate of the first segment end point

x2 - north/south coordinate of the second segment end point

y2 - east west coordinate of the second segment end point

Returns:

the direction (radians) from this segment to the line segment

getIntersectPoint

public double[] getIntersectPoint(double x1,
                         double y1,
                         double x2,
                         double y2)

Computes the point of intersection of the extended lines of this and another segment

Parameters:

x1 - north/south coordinate of the first segment end point

y1 - east west coordinate of the first segment end point

x2 - north/south coordinate of the second segment end point

y2 - east west coordinate of the second segment end point

Returns:

the point of intersection (null if parallel). NOTE: may not be on either segment!

toString

public String toString()

Generates a string representation of the LineSegment object

Overrides:

toString in class Object