icy.type.geom

Class Line3D

java.lang.Object

icy.type.geom.Line3D

All Implemented Interfaces:

Shape3D, java.lang.Cloneable

public class Line3D
extends java.lang.Object
implements Shape3D, java.lang.Cloneable

This Line3D (3D equivalent to java Line2D class) represents a 3D line segment in (x,y,z) coordinate space.

Author:

Stephane

Constructor Summary

Constructors

Constructor and Description
Line3D() Constructs and initializes a Line with coordinates (0, 0, 0) -> (0, 0, 0).
Line3D(double x1, double y1, double z1, double x2, double y2, double z2) Constructs and initializes a Line from the specified coordinates.
Line3D(Line3D l) Constructs and initializes a Line3D from the specified Line3D object.
Line3D(Point3D p1, Point3D p2) Constructs and initializes a Line3D from the specified Point3D objects.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	clone() Creates a new object of the same class as this object.
boolean	contains(double x, double y, double z) Tests if a specified coordinate is inside the boundary of this Line3D.
boolean	contains(double x, double y, double z, double sizeX, double sizeY, double sizeZ) Tests if the interior of this Line3D entirely contains the specified set of rectangular coordinates.
boolean	contains(Point3D p) Tests if a given Point3D is inside the boundary of this Line3D.
boolean	contains(Rectangle3D r) Tests if the interior of this Line3D entirely contains the specified Rectangle3D.
Rectangle3D	getBounds() Returns the bounding box of the Shape3D.
Point3D	getP1() Returns the start Point3D of this Line3D.
Point3D	getP2() Returns the end Point3D of this Line3D.
Point3D	getVector() Returns the vector representing this Line3D.
double	getX1() Returns the X coordinate of the start point in double precision.
double	getX2() Returns the X coordinate of the end point in double precision.
double	getY1() Returns the Y coordinate of the start point in double precision.
double	getY2() Returns the Y coordinate of the end point in double precision.
double	getZ1() Returns the Z coordinate of the start point in double precision.
double	getZ2() Returns the Z coordinate of the end point in double precision.
boolean	intersects(double x, double y, double z, double sizeX, double sizeY, double sizeZ) Tests if the interior of the Shape3D intersects the interior of a specified 3D rectangular area.
boolean	intersects(Rectangle3D r) Tests if the interior of the Shape3D intersects the interior of a specified Rectangle3D.
boolean	intersectsLine(double x1, double y1, double z1, double x2, double y2, double z2) Tests if the line segment from (x1,y1,z1) to (x2,y2,z2) intersects this line segment.
boolean	intersectsLine(Line3D l) Tests if the specified line segment intersects this line segment.
static boolean	linesIntersect(double x1, double y1, double z1, double x2, double y2, double z2, double x3, double y3, double z3, double x4, double y4, double z4) Tests if the line segment from (x1,y1,z1) to (x2,y2,z2) intersects the line segment from (x3,y3,z3) to (x4,y4,z4).
double	ptLineDist(double px, double py, double pz) Returns the distance from a point to this line.
static double	ptLineDist(double x1, double y1, double z1, double x2, double y2, double z2, double px, double py, double pz) Returns the distance from a point to a line.
double	ptLineDist(Point3D pt) Returns the distance from a Point3D to this line.
double	ptLineDistSq(double px, double py, double pz) Returns the square of the distance from a point to this line.
static double	ptLineDistSq(double x1, double y1, double z1, double x2, double y2, double z2, double px, double py, double pz) Returns the square of the distance from a point to a line.
double	ptLineDistSq(Point3D pt) Returns the square of the distance from a specified Point3D to this line.
double	ptSegDist(double px, double py, double pz) Returns the distance from a point to this line segment.
static double	ptSegDist(double x1, double y1, double z1, double x2, double y2, double z2, double px, double py, double pz) Returns the distance from a point to a line segment.
double	ptSegDist(Point3D pt) Returns the distance from a Point3D to this line segment.
double	ptSegDistSq(double px, double py, double pz) Returns the square of the distance from a point to this line segment.
static double	ptSegDistSq(double x1, double y1, double z1, double x2, double y2, double z2, double px, double py, double pz) Returns the square of the distance from a point to a line segment.
double	ptSegDistSq(Point3D pt) Returns the square of the distance from a Point3D to this line segment.
void	setLine(double x1, double y1, double z1, double x2, double y2, double z2) Sets the location of the end points of this Line3D to the specified double coordinates.
void	setLine(Line3D l) Sets the location of the end points of this Line3D to the same as those end points of the specified Line3D.
void	setLine(Point3D p1, Point3D p2) Sets the location of the end points of this Line3D to the specified Point3D coordinates.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Line3D

public Line3D()

Constructs and initializes a Line with coordinates (0, 0, 0) -> (0, 0, 0).

Line3D

public Line3D(double x1,
      double y1,
      double z1,
      double x2,
      double y2,
      double z2)

Constructs and initializes a Line from the specified coordinates.

Parameters:

x1 - the X coordinate of the start point

y1 - the Y coordinate of the start point

z1 - the Z coordinate of the start point

x2 - the X coordinate of the end point

y2 - the Y coordinate of the end point

z2 - the Z coordinate of the end point

Line3D

public Line3D(Point3D p1,
      Point3D p2)

Constructs and initializes a Line3D from the specified Point3D objects.

Parameters:

p1 - the start Point3D of this line segment

p2 - the end Point3D of this line segment

Line3D

public Line3D(Line3D l)

Constructs and initializes a Line3D from the specified Line3D object.

Parameters:

l - the Line3D to copy

Method Detail

getX1

public double getX1()

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

Returns:

the X coordinate of the start point of this Line3D object.

getY1

public double getY1()

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

Returns:

the Y coordinate of the start point of this Line3D object.

getZ1

public double getZ1()

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

Returns:

the Z coordinate of the start point of this Line3D object.

getP1

public Point3D getP1()

Returns the start Point3D of this Line3D.

Returns:

the start Point3D of this Line3D.

getX2

public double getX2()

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

Returns:

the X coordinate of the end point of this Line3D object.

getY2

public double getY2()

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

Returns:

the Y coordinate of the end point of this Line3D object.

getZ2

public double getZ2()

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

Returns:

the Z coordinate of the end point of this Line3D object.

getP2

public Point3D getP2()

Returns the end Point3D of this Line3D.

Returns:

the end Point3D of this Line3D.

getVector

public Point3D getVector()

Returns the vector representing this Line3D.

Returns:

the vector representing this Line3D.

setLine

public void setLine(double x1,
           double y1,
           double z1,
           double x2,
           double y2,
           double z2)

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

Parameters:

x1 - the X coordinate of the start point

y1 - the Y coordinate of the start point

z1 - the Z coordinate of the start point

x2 - the X coordinate of the end point

y2 - the Y coordinate of the end point

z2 - the Z coordinate of the start point

getBounds

public Rectangle3D getBounds()

Description copied from interface: Shape3D

Returns the bounding box of the Shape3D. Note that there is no guarantee that the returned Rectangle3D is the smallest bounding box that encloses the Shape3D, only that the Shape3D lies entirely within the indicated Rectangle3D.

Specified by:

getBounds in interface Shape3D

Returns:

an instance of Rectangle3D that is a high-precision bounding box of the Shape3D.

setLine

public void setLine(Point3D p1,
           Point3D p2)

Sets the location of the end points of this Line3D to the specified Point3D coordinates.

Parameters:

p1 - the start Point3D of the line segment

p2 - the end Point3D of the line segment

setLine

public void setLine(Line3D l)

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

Parameters:

l - the specified Line3D

linesIntersect

public static boolean linesIntersect(double x1,
                     double y1,
                     double z1,
                     double x2,
                     double y2,
                     double z2,
                     double x3,
                     double y3,
                     double z3,
                     double x4,
                     double y4,
                     double z4)

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

Parameters:

x1 - the X coordinate of the start point of the first line segment

y1 - the Y coordinate of the start point of the first line segment

z1 - the Z coordinate of the start point of the first line segment

x2 - the X coordinate of the end point of the first line segment

y2 - the Y coordinate of the end point of the first line segment

z2 - the Z coordinate of the end point of the first line segment

x3 - the X coordinate of the start point of the end line segment

y3 - the Y coordinate of the start point of the end line segment

z3 - the Z coordinate of the start point of the end line segment

x4 - the X coordinate of the end point of the end line segment

y4 - the Y coordinate of the end point of the end line segment

z4 - the Z coordinate of the end point of the end line segment

Returns:

true if the first specified line segment and the second specified line segment intersect each other; false otherwise.

intersectsLine

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

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

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

z1 - the Z 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

z2 - the Z coordinate of the end point of the specified line segment

Returns:

if this line segment and the specified line segment intersect each other; false otherwise.

intersectsLine

public boolean intersectsLine(Line3D l)

Tests if the specified line segment intersects this line segment.

Parameters:

l - the specified Line3D

Returns:

true if this line segment and the specified line segment intersect each other; false otherwise.

ptSegDistSq

public static double ptSegDistSq(double x1,
                 double y1,
                 double z1,
                 double x2,
                 double y2,
                 double z2,
                 double px,
                 double py,
                 double pz)

Returns the square of the distance from a point to a line segment. The distance measured is the distance between the specified point and the closest point between the specified end points. If the specified point intersects the line segment in between the end points, this method returns 0.0.

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

z1 - the Z 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

z2 - the Z coordinate of the end point of the specified line segment

px - the X coordinate of the specified point being measured against the specified line segment

py - the Y coordinate of the specified point being measured against the specified line segment

pz - the Z coordinate of the specified point being measured against the specified line segment

Returns:

a double value that is the square of the distance from the specified point to the specified line segment.

See Also:

ptLineDistSq(double,double,double,double, double, double, double, double, double)

ptSegDist

public static double ptSegDist(double x1,
               double y1,
               double z1,
               double x2,
               double y2,
               double z2,
               double px,
               double py,
               double pz)

Returns the distance from a point to a line segment. The distance measured is the distance between the specified point and the closest point between the specified end points. If the specified point intersects the line segment in between the end points, this method returns 0.0.

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

z1 - the Z 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

z2 - the Z coordinate of the end point of the specified line segment

px - the X coordinate of the specified point being measured against the specified line segment

py - the Y coordinate of the specified point being measured against the specified line segment

pz - the Z coordinate of the specified point being measured against the specified line segment

Returns:

a double value that is the distance from the specified point to the specified line segment.

See Also:

ptLineDist(double, double, double, double,double, double, double, double, double)

ptSegDistSq

public double ptSegDistSq(double px,
                 double py,
                 double pz)

Returns the square of the distance from a point 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.

Parameters:

px - the X coordinate of the specified point being measured against this line segment

py - the Y coordinate of the specified point being measured against this line segment

pz - the Z coordinate of the specified point being measured against this line segment

Returns:

a double value that is the square of the distance from the specified point to the current line segment.

See Also:

ptLineDistSq(double, double,double)

ptSegDistSq

public double ptSegDistSq(Point3D pt)

Returns the square of the distance from a Point3D 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.

Parameters:

pt - the specified Point3D being measured against this line segment.

Returns:

a double value that is the square of the distance from the specified Point3D to the current line segment.

See Also:

ptLineDistSq(Point3D)

ptSegDist

public double ptSegDist(double px,
               double py,
               double pz)

Returns the distance from a point 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.

Parameters:

px - the X coordinate of the specified point being measured against this line segment

py - the Y coordinate of the specified point being measured against this line segment

pz - the Z coordinate of the specified point being measured against this line segment

Returns:

a double value that is the distance from the specified point to the current line segment.

See Also:

ptLineDist(double, double, double)

ptSegDist

public double ptSegDist(Point3D pt)

Returns the distance from a Point3D 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.

Parameters:

pt - the specified Point3D being measured against this line segment

Returns:

a double value that is the distance from the specified Point3D to the current line segment.

See Also:

ptLineDist(Point3D)

ptLineDistSq

public static double ptLineDistSq(double x1,
                  double y1,
                  double z1,
                  double x2,
                  double y2,
                  double z2,
                  double px,
                  double py,
                  double pz)

Returns the square of the distance from a point to a line. The distance measured is the distance between the specified point and the closest point on the infinitely-extended line defined by the specified coordinates. If the specified point intersects the line, this method returns 0.0.

Parameters:

x1 - the X coordinate of the start point of the specified line

y1 - the Y coordinate of the start point of the specified line

z1 - the Z coordinate of the start point of the specified line

x2 - the X coordinate of the end point of the specified line

y2 - the Y coordinate of the end point of the specified line

z2 - the Z coordinate of the end point of the specified line

px - the X coordinate of the specified point being measured against the specified line

py - the Y coordinate of the specified point being measured against the specified line

pz - the Z coordinate of the specified point being measured against the specified line

Returns:

a double value that is the square of the distance from the specified point to the specified line.

See Also:

ptSegDistSq(double, double, double, double,double, double, double, double, double)

ptLineDist

public static double ptLineDist(double x1,
                double y1,
                double z1,
                double x2,
                double y2,
                double z2,
                double px,
                double py,
                double pz)

Returns the distance from a point to a line. The distance measured is the distance between the specified point and the closest point on the infinitely-extended line defined by the specified coordinates. If the specified point intersects the line, this method returns 0.0.

Parameters:

x1 - the X coordinate of the start point of the specified line

y1 - the Y coordinate of the start point of the specified line

z1 - the Z coordinate of the start point of the specified line

x2 - the X coordinate of the end point of the specified line

y2 - the Y coordinate of the end point of the specified line

z2 - the Z coordinate of the end point of the specified line

px - the X coordinate of the specified point being measured against the specified line

py - the Y coordinate of the specified point being measured against the specified line

pz - the Z coordinate of the specified point being measured against the specified line

Returns:

a double value that is the distance from the specified point to the specified line.

See Also:

ptSegDist(double, double, double, double, double, double, double, double, double)

ptLineDistSq

public double ptLineDistSq(double px,
                  double py,
                  double pz)

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 Line3D. If the specified point intersects the line, this method returns 0.0.

Parameters:

px - the X coordinate of the specified point being measured against the specified line

py - the Y coordinate of the specified point being measured against the specified line

pz - the Z coordinate of the specified point being measured against the specified line

Returns:

a double value that is the square of the distance from a specified point to the current line.

See Also:

ptSegDistSq(double, double, double)

ptLineDistSq

public double ptLineDistSq(Point3D pt)

Returns the square of the distance from a specified Point3D 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 Line3D. If the specified point intersects the line, this method returns 0.0.

Parameters:

pt - the specified Point3D being measured against this line

Returns:

a double value that is the square of the distance from a specified Point3D to the current line.

See Also:

ptSegDistSq(Point3D)

ptLineDist

public double ptLineDist(double px,
                double py,
                double pz)

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 Line3D. If the specified point intersects the line, this method returns 0.0.

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

pz - the Z coordinate of the specified point being measured against this line

Returns:

a double value that is the distance from a specified point to the current line.

See Also:

ptSegDist(double, double, double)

ptLineDist

public double ptLineDist(Point3D pt)

Returns the distance from a Point3D 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 Line3D. If the specified point intersects the line, this method returns 0.0.

Parameters:

pt - the specified Point3D being measured

Returns:

a double value that is the distance from a specified Point3D to the current line.

See Also:

ptSegDist(Point3D)

contains

public boolean contains(double x,
               double y,
               double z)

Tests if a specified coordinate is inside the boundary of this Line3D. This method is required to implement the Shape3D interface, but in the case of Line3D objects it always returns false since a line contains no area.

Specified by:

contains in interface Shape3D

Parameters:

x - the X coordinate of the specified point to be tested

y - the Y coordinate of the specified point to be tested

z - the Z coordinate of the specified point to be tested

Returns:

false because a Line3D contains no area.

contains

public boolean contains(Point3D p)

Tests if a given Point3D is inside the boundary of this Line3D. This method is required to implement the Shape3D interface, but in the case of Line3D objects it always returns false since a line contains no area.

Specified by:

contains in interface Shape3D

Parameters:

p - the specified Point3D to be tested

Returns:

false because a Line3D contains no area.

contains

public boolean contains(double x,
               double y,
               double z,
               double sizeX,
               double sizeY,
               double sizeZ)

Tests if the interior of this Line3D entirely contains the specified set of rectangular coordinates. This method is required to implement the Shape3D interface, but in the case of Line3D objects it always returns false since a line contains no area.

Specified by:

contains in interface Shape3D

Parameters:

x - the X coordinate of the closest-upper-left corner of the specified 3D rectangular area

y - the Y coordinate of the closest-upper-left corner of the specified 3D rectangular area

z - the Z coordinate of the closest-upper-left corner of the specified 3D rectangular area

sizeX - the width of the specified 3D rectangular area

sizeY - the height of the specified 3D rectangular area

sizeZ - the depth of the specified 3D rectangular area

Returns:

false because a Line3D contains no area.

contains

public boolean contains(Rectangle3D r)

Tests if the interior of this Line3D entirely contains the specified Rectangle3D. This method is required to implement the Shape3D interface, but in the case of Line3D objects it always returns false since a line contains no area.

Specified by:

contains in interface Shape3D

Parameters:

r - the specified Rectangle3D to be tested

Returns:

false because a Line3D contains no area.

See Also:

Shape3D.contains(double, double, double, double, double, double)

intersects

public boolean intersects(double x,
                 double y,
                 double z,
                 double sizeX,
                 double sizeY,
                 double sizeZ)

Description copied from interface: Shape3D

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

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

• there is a high probability that the 3D rectangular area and the Shape3D 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 3D rectangular area does not intersect the Shape3D.

Specified by:

intersects in interface Shape3D

Parameters:

x - the X coordinate of the closest-upper-left corner of the specified 3D rectangular area

y - the Y coordinate of the closest-upper-left corner of the specified 3D rectangular area

z - the Z coordinate of the closest-upper-left corner of the specified 3D rectangular area

sizeX - the width of the specified 3D rectangular area

sizeY - the height of the specified 3D rectangular area

sizeZ - the depth of the specified 3D rectangular area

Returns:

true if the interior of the Shape3D and the interior of the 3D rectangular area intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.

intersects

public boolean intersects(Rectangle3D r)

Description copied from interface: Shape3D

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

• there is a high probability that the Rectangle3D and the Shape3D 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 Rectangle3D does not intersect the Shape3D.

Specified by:

intersects in interface Shape3D

Parameters:

r - the specified Rectangle3D

Returns:

true if the interior of the Shape3D and the interior of the specified Rectangle3D intersect, or are both highly likely to intersect and intersection calculations would be too expensive to perform; false otherwise.

See Also:

Shape3D.intersects(double, double, double, double, double, double)

clone

public java.lang.Object clone()

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

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

Throws:

java.lang.OutOfMemoryError - if there is not enough memory.

See Also:

Cloneable