org.mini2Dx.core.geom

Class LineSegment

java.lang.Object

org.mini2Dx.core.geom.LineSegment

Direct Known Subclasses:

Line

public class LineSegment
extends java.lang.Object

Represents a segment of a line (the space between two points)

Field Summary

Fields

Modifier and Type	Field and Description
protected Point	pointA
protected Point	pointB

Constructor Summary

Constructors

Constructor and Description
LineSegment(float x1, float y1, float x2, float y2) Constructs a line segment between point A and point B
LineSegment(Point pA, Point pB) Constructs a line segment between point A and point B

Method Summary

Modifier and Type	Method and Description
boolean	contains(float x, float y) Returns if the coordinate x,y is on the line between point A and point B
boolean	equals(java.lang.Object obj)
Point	getIntersection(LineSegment lineSegment) Deprecated.
boolean	getIntersection(LineSegment lineSegment, Point result) Returns the point at which this LineSegment intersects with another
float	getLength()
float	getMaxX()
float	getMaxY()
float	getMinX()
float	getMinY()
Point	getPointA()
Point	getPointB()
int	hashCode()
boolean	intersects(LineSegment lineSegment) Returns if this LineSegment intersects another LineSegment
boolean	intersects(Rectangle rectangle) Returns if a Rectangle intersects this LineSegment
boolean	intersectsLineSegment(float segmentX1, float segmentY1, float segmentX2, float segmentY2)
void	set(float x1, float y1, float x2, float y2) Sets the coordinates of point A and point B
void	setPointA(Point pointA)
void	setPointB(Point pointB)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

pointA

protected Point pointA

pointB

protected Point pointB

Constructor Detail

LineSegment

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

Constructs a line segment between point A and point B

Parameters:

x1 - The x coordinate of point A

y1 - The y coordinate of point A

x2 - The x coordinate of point B

y2 - The y coordinate of point B

LineSegment

public LineSegment(Point pA,
                   Point pB)

Constructs a line segment between point A and point B

Parameters:

pA - Point A

pB - Point B

Method Detail

set

public void set(float x1,
                float y1,
                float x2,
                float y2)

Sets the coordinates of point A and point B

Parameters:

x1 - The x coordinate of point A

y1 - The y coordinate of point A

x2 - The x coordinate of point B

y2 - The y coordinate of point B

contains

public boolean contains(float x,
                        float y)

Returns if the coordinate x,y is on the line between point A and point B

Parameters:

x - The x coordinate

y - The y coordinate

Returns:

False if the coordinate is not on the line between point A and point B

intersectsLineSegment

public boolean intersectsLineSegment(float segmentX1,
                                     float segmentY1,
                                     float segmentX2,
                                     float segmentY2)

intersects

public boolean intersects(LineSegment lineSegment)

Returns if this LineSegment intersects another LineSegment

Parameters:

lineSegment - The LineSegment to check for intersection with

Returns:

True if this line intersects with lineSegment

getIntersection

@Deprecated
public Point getIntersection(LineSegment lineSegment)

Deprecated.

Returns the point at which this LineSegment intersects with another

Parameters:

lineSegment - The LineSegment to check for intersection with

Returns:

Null if the LineSegments don't intersect

getIntersection

public boolean getIntersection(LineSegment lineSegment,
                               Point result)

Returns the point at which this LineSegment intersects with another

Parameters:

lineSegment - The LineSegment to check for intersection with

result - The Point at which the lines intersect

Returns:

True if the lines intersect, false otherwise

intersects

public boolean intersects(Rectangle rectangle)

Returns if a Rectangle intersects this LineSegment

Parameters:

rectangle - The Rectangle to test for intersection

Returns:

False if this LineSegment does not intersect the Rectangle

getPointA

public Point getPointA()

setPointA

public void setPointA(Point pointA)

getPointB

public Point getPointB()

setPointB

public void setPointB(Point pointB)

getMinX

public float getMinX()

getMinY

public float getMinY()

getMaxX

public float getMaxX()

getMaxY

public float getMaxY()

getLength

public float getLength()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object