Line2D JDK 1.6)

Hide/Show inherited methods

public Object clone ()

Creates a new object of the same class as this object.

public boolean contains (double x, double y) [Specified in Shape]

Tests if a specified coordinate is inside the boundary of this Line2D.

Tests if a specified coordinate is inside the boundary of this
Line2D. This method is required to implement the
Shape interface, but in the case of Line2D
objects it always returns false since a line contains
no area.
Returns: false because a Line2D contains no area.
Parameters:
- x - the X coordinate of the specified point to be tested
- y - the Y coordinate of the specified point to be tested
Since: 1.2

public boolean contains (double x, double y, double w, double h) [Specified in Shape]

Tests if the interior of this Line2D entirely contains the specified set of rectangular coordinates.

Tests if the interior of this Line2D entirely contains
the specified set of rectangular coordinates.
This method is required to implement the Shape interface,
but in the case of Line2D objects it always returns
false since a line contains no area.
Returns: false because a Line2D contains no area.
Parameters:
- x - the X coordinate of the upper-left corner of the specified rectangular area
- y - the Y coordinate of the upper-left corner of the specified rectangular area
- w - the width of the specified rectangular area
- h - the height of the specified rectangular area
Since: 1.2

public boolean contains (Point2D p) [Specified in Shape]

Tests if a given Point2D is inside the boundary of this Line2D.

Tests if a given Point2D is inside the boundary of
this Line2D.
This method is required to implement the Shape interface,
but in the case of Line2D objects it always returns
false since a line contains no area.
Returns: false because a Line2D contains no area.
Parameters:
- p - the specified Point2D to be tested
Since: 1.2

public boolean contains (Rectangle2D r) [Specified in Shape]

Tests if the interior of this Line2D entirely contains the specified Rectangle2D.

Tests if the interior of this Line2D entirely contains
the specified Rectangle2D.
This method is required to implement the Shape interface,
but in the case of Line2D objects it always returns
false since a line contains no area.
Returns: false because a Line2D contains no area.
Parameters:
- r - the specified Rectangle2D to be tested
Since: 1.2

public Rectangle getBounds () [Specified in Shape]

Returns an integer Rectangle that completely encloses the Shape.

Returns an integer Rectangle that completely encloses the
Shape. Note that there is no guarantee that the
returned Rectangle is the smallest bounding box that
encloses the Shape, only that the Shape
lies entirely within the indicated Rectangle. The
returned Rectangle might also fail to completely
enclose the Shape if the Shape overflows
the limited range of the integer data type. The
getBounds2D method generally returns a
tighter bounding box due to its greater flexibility in
representation.
Since: 1.2

publicabstract Point2D getP1 ()

Returns the start Point2D of this Line2D.

Returns the start Point2D of this Line2D.
Returns: the start Point2D of this Line2D.
Since: 1.2

publicabstract Point2D getP2 ()

Returns the end Point2D of this Line2D.

Returns the end Point2D of this Line2D.
Returns: the end Point2D of this Line2D.
Since: 1.2

public PathIterator getPathIterator (AffineTransform at) [Specified in Shape]

Returns an iteration object that defines the boundary of this Line2D.

Returns an iteration object that defines the boundary of this
Line2D.
The iterator for this class is not multi-threaded safe,
which means that this Line2D class does not
guarantee that modifications to the geometry of this
Line2D object do not affect any iterations of that
geometry that are already in process.
Returns: a {@link PathIterator} that defines the boundary of this Line2D.
Parameters:
- at - the specified {@link AffineTransform}
Since: 1.2

public PathIterator getPathIterator (AffineTransform at, double flatness) [Specified in Shape]

Returns an iteration object that defines the boundary of this flattened Line2D.

Returns an iteration object that defines the boundary of this
flattened Line2D.
The iterator for this class is not multi-threaded safe,
which means that this Line2D class does not
guarantee that modifications to the geometry of this
Line2D object do not affect any iterations of that
geometry that are already in process.
Returns: a PathIterator that defines the boundary of the flattened Line2D
Parameters:
- at - the specified AffineTransform
- flatness - the maximum amount that the control points for a given curve can vary from colinear before a subdivided curve is replaced by a straight line connecting the end points. Since a Line2D object is always flat, this parameter is ignored.
Since: 1.2

publicabstract double getX1 ()

Returns the X coordinate of the start point in double precision.

publicabstract double getX2 ()

Returns the X coordinate of the end point in double precision.

publicabstract double getY1 ()

Returns the Y coordinate of the start point in double precision.

publicabstract double getY2 ()

Returns the Y coordinate of the end point in double precision.

public boolean intersects (double x, double y, double w, double h) [Specified in Shape]

Tests if the interior of the Shape intersects the interior of a specified rectangular area.

Tests if the interior of the Shape intersects the interior of a specified rectangular area. The rectangular area is considered to intersect the Shape if any point is contained in both the interior of the Shape and the specified rectangular area.

The Shape.intersects() method allows a Shape implementation to conservatively return true when:

there is a high probability that the rectangular area and the Shape intersect, but
the calculations to accurately determine this intersection are prohibitively expensive.

This means that for some Shapes this method might return true even though the rectangular area does not intersect the Shape. The Area class performs more accurate computations of geometric intersection than most Shape objects and therefore can be used if a more precise answer is required.
Since: 1.2

public boolean intersects (Rectangle2D r) [Specified in Shape]

Tests if the interior of the Shape intersects the interior of a specified Rectangle2D.

Tests if the interior of the Shape intersects the
interior of a specified Rectangle2D.
The Shape.intersects() method allows a Shape
implementation to conservatively return true when:

there is a high probability that the Rectangle2D and the
Shape intersect, but
the calculations to accurately determine this intersection
are prohibitively expensive.

This means that for some Shapes this method might
return true even though the Rectangle2D does not
intersect the Shape.
The Area class performs
more accurate computations of geometric intersection than most
Shape objects and therefore can be used if a more precise
answer is required.
Since: 1.2

public boolean intersectsLine (double x1, double y1, double x2, double y2)

Tests if the line segment from (x1,y1) to (x2,y2) intersects this line segment.

Tests if the line segment from (x1,y1) to
(x2,y2) intersects this line segment.
Returns: if this line segment and the specified line segment intersect each other; false otherwise.
Parameters:
- x1 - the X coordinate of the start point of the specified line segment
- y1 - the Y coordinate of the start point of the specified line segment
- x2 - the X coordinate of the end point of the specified line segment
- y2 - the Y coordinate of the end point of the specified line segment
Since: 1.2

public boolean intersectsLine (Line2D l)

Tests if the specified line segment intersects this line segment.

Tests if the specified line segment intersects this line segment.
Returns: true if this line segment and the specified line segment intersect each other; false otherwise.
Parameters:
- l - the specified Line2D
Since: 1.2

publicstatic boolean linesIntersect (double x1, double y1, double x2, double y2, double x3, double y3, double x4, double y4)

Tests if the line segment from (x1,y1) to (x2,y2) intersects the line segment from (x3,y3) to (x4,y4).

Tests if the line segment from (x1,y1) to
(x2,y2) intersects the line segment from (x3,y3)
to (x4,y4).
Returns: true if the first specified line segment and the second specified line segment intersect each other; false otherwise.
Parameters:
- x1 - the X coordinate of the start point of the first specified line segment
- y1 - the Y coordinate of the start point of the first specified line segment
- x2 - the X coordinate of the end point of the first specified line segment
- y2 - the Y coordinate of the end point of the first specified line segment
- x3 - the X coordinate of the start point of the second specified line segment
- y3 - the Y coordinate of the start point of the second specified line segment
- x4 - the X coordinate of the end point of the second specified line segment
- y4 - the Y coordinate of the end point of the second specified line segment
Since: 1.2

public double ptLineDist (double px, double py)

Returns the distance from a point to this line.

Returns the distance from a point to this line.
The distance measured is the distance between the specified
point and the closest point on the infinitely-extended line
defined by this Line2D. If the specified point
intersects the line, this method returns 0.0.
Returns: a double value that is the distance from a specified point to the current line.
Parameters:
- px - the X coordinate of the specified point being measured against this line
- py - the Y coordinate of the specified point being measured against this line
Since: 1.2
See Also: Line2D.ptSegDist(double, double),

publicstatic double ptLineDist (double x1, double y1, double x2, double y2, double px, double py)

Returns the distance from a point to a line.

public double ptLineDist (Point2D pt)

Returns the distance from a Point2D to this line.

Returns the distance from a Point2D to this line.
The distance measured is the distance between the specified
point and the closest point on the infinitely-extended line
defined by this Line2D. If the specified point
intersects the line, this method returns 0.0.
Returns: a double value that is the distance from a specified Point2D to the current line.
Parameters:
- pt - the specified Point2D being measured
Since: 1.2
See Also: Line2D.ptSegDist(Point2D),

public double ptLineDistSq (double px, double py)

Returns the square of the distance from a point to this line.

Returns the square of the distance from a point to this line.
The distance measured is the distance between the specified
point and the closest point on the infinitely-extended line
defined by this Line2D. If the specified point
intersects the line, this method returns 0.0.
Returns: a double value that is the square of the distance from a specified point to the current line.
Parameters:
- px - the X coordinate of the specified point being measured against this line
- py - the Y coordinate of the specified point being measured against this line
Since: 1.2
See Also: Line2D.ptSegDistSq(double, double),

publicstatic double ptLineDistSq (double x1, double y1, double x2, double y2, double px, double py)

Returns the square of the distance from a point to a line.

public double ptLineDistSq (Point2D pt)

Returns the square of the distance from a specified Point2D to this line.

Returns the square of the distance from a specified
Point2D to this line.
The distance measured is the distance between the specified
point and the closest point on the infinitely-extended line
defined by this Line2D. If the specified point
intersects the line, this method returns 0.0.
Returns: a double value that is the square of the distance from a specified Point2D to the current line.
Parameters:
- pt - the specified Point2D being measured against this line
Since: 1.2
See Also: Line2D.ptSegDistSq(Point2D),

public double ptSegDist (double px, double py)

Returns the distance from a point to this line segment.

publicstatic double ptSegDist (double x1, double y1, double x2, double y2, double px, double py)

Returns the distance from a point to a line segment.

public double ptSegDist (Point2D pt)

Returns the distance from a Point2D to this line segment.

Returns the distance from a Point2D to this line
segment.
The distance measured is the distance between the specified
point and the closest point between the current line's end points.
If the specified point intersects the line segment in between the
end points, this method returns 0.0.
Returns: a double value that is the distance from the specified Point2D to the current line segment.
Parameters:
- pt - the specified Point2D being measured against this line segment
Since: 1.2
See Also: Line2D.ptLineDist(Point2D),

public double ptSegDistSq (double px, double py)

Returns the square of the distance from a point to this line segment.

publicstatic double ptSegDistSq (double x1, double y1, double x2, double y2, double px, double py)

Returns the square of the distance from a point to a line segment.

public double ptSegDistSq (Point2D pt)

Returns the square of the distance from a Point2D to this line segment.

Returns the square of the distance from a Point2D to
this line segment.
The distance measured is the distance between the specified
point and the closest point between the current line's end points.
If the specified point intersects the line segment in between the
end points, this method returns 0.0.
Returns: a double value that is the square of the distance from the specified Point2D to the current line segment.
Parameters:
- pt - the specified Point2D being measured against this line segment.
Since: 1.2
See Also: Line2D.ptLineDistSq(Point2D),

public int relativeCCW (double px, double py)

Returns an indicator of where the specified point (px,py) lies with respect to this line segment.

Returns an indicator of where the specified point
(px,py) lies with respect to this line segment.
See the method comments of
Line2D.relativeCCW(double, double, double, double, double, double)
to interpret the return value.
Returns: an integer that indicates the position of the specified coordinates with respect to this Line2D
Parameters:
- px - the X coordinate of the specified point to be compared with this Line2D
- py - the Y coordinate of the specified point to be compared with this Line2D
Since: 1.2
See Also: Line2D.relativeCCW(double, double, double, double, double, double),

publicstatic int relativeCCW (double x1, double y1, double x2, double y2, double px, double py)

Returns an indicator of where the specified point (px,py) lies with respect to the line segment from (x1,y1) to (x2,y2).

Returns an indicator of where the specified point (px,py) lies with respect to the line segment from (x1,y1) to (x2,y2). The return value can be either 1, -1, or 0 and indicates in which direction the specified line must pivot around its first end point, (x1,y1), in order to point at the specified point (px,py).

A return value of 1 indicates that the line segment must turn in the direction that takes the positive X axis towards the negative Y axis. In the default coordinate system used by Java 2D, this direction is counterclockwise.

A return value of -1 indicates that the line segment must turn in the direction that takes the positive X axis towards the positive Y axis. In the default coordinate system, this direction is clockwise.

A return value of 0 indicates that the point lies exactly on the line segment. Note that an indicator value of 0 is rare and not useful for determining colinearity because of floating point rounding issues.

If the point is colinear with the line segment, but not between the end points, then the value will be -1 if the point lies "beyond (x1,y1)" or 1 if the point lies "beyond (x2,y2)".
Returns: an integer that indicates the position of the third specified coordinates with respect to the line segment formed by the first two specified coordinates.
Parameters:
- x1 - the X coordinate of the start point of the specified line segment
- y1 - the Y coordinate of the start point of the specified line segment
- x2 - the X coordinate of the end point of the specified line segment
- y2 - the Y coordinate of the end point of the specified line segment
- px - the X coordinate of the specified point to be compared with the specified line segment
- py - the Y coordinate of the specified point to be compared with the specified line segment
Since: 1.2

public int relativeCCW (Point2D p)

Returns an indicator of where the specified Point2D lies with respect to this line segment.

Returns an indicator of where the specified Point2D
lies with respect to this line segment.
See the method comments of
Line2D.relativeCCW(double, double, double, double, double, double)
to interpret the return value.
Returns: an integer that indicates the position of the specified Point2D with respect to this Line2D
Parameters:
- p - the specified Point2D to be compared with this Line2D
Since: 1.2
See Also: Line2D.relativeCCW(double, double, double, double, double, double),

publicabstract void setLine (double x1, double y1, double x2, double y2)

Sets the location of the end points of this Line2D to the specified double coordinates.

Sets the location of the end points of this Line2D to
the specified double coordinates.
Parameters:
- x1 - the X coordinate of the start point
- y1 - the Y coordinate of the start point
- x2 - the X coordinate of the end point
- y2 - the Y coordinate of the end point
Since: 1.2

public void setLine (Line2D l)

Sets the location of the end points of this Line2D to the same as those end points of the specified Line2D.

Sets the location of the end points of this Line2D to
the same as those end points of the specified Line2D.
Parameters:
- l - the specified Line2D
Since: 1.2

public void setLine (Point2D p1, Point2D p2)

Sets the location of the end points of this Line2D to the specified Point2D coordinates.

Sets the location of the end points of this Line2D to
the specified Point2D coordinates.
Parameters:
- p1 - the start Point2D of the line segment
- p2 - the end Point2D of the line segment
Since: 1.2