icy.type.geom

Class Polyline3D

java.lang.Object

icy.type.geom.Polyline3D

All Implemented Interfaces:

Shape3D, java.lang.Cloneable

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

Field Summary

Fields

Modifier and Type	Field and Description
int	npoints The total number of points.
double[]	xpoints The array of x coordinates.
double[]	ypoints The array of y coordinates.
double[]	zpoints The array of z coordinates.

Constructor Summary

Constructors

Constructor and Description
Polyline3D() Creates an empty Polyline3D.
Polyline3D(double[] xpoints, double[] ypoints, double[] zpoints, int npoints) Constructs and initializes a Polyline3D from the specified parameters.
Polyline3D(int[] xpoints, int[] ypoints, int[] zpoints, int npoints) Constructs and initializes a Polyline3D from the specified parameters.
Polyline3D(Line3D line)

Method Summary

Methods

Modifier and Type	Method and Description
void	addPoint(double x, double y, double z) Appends the specified coordinates to this Polyline3D.
void	addPoint(Point3D p) Appends the specified coordinates to this Polyline3D.
void	calculateLines()
java.lang.Object	clone()
boolean	contains(double x, double y, double z) Tests if the specified 3D coordinates are inside the boundary of the Shape3D.
boolean	contains(double x, double y, double z, double sizeX, double sizeY, double sizeZ) Tests if the interior of the Shape3D entirely contains the specified 3D rectangular area.
boolean	contains(Point3D p) Tests if a specified Point3D is inside the boundary of the Shape3D.
boolean	contains(Rectangle3D r) Tests if the interior of the Shape3D entirely contains the specified Rectangle3D.
Rectangle3D	getBounds() Returns the bounding box of the Shape3D.
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.
void	reset() Resets this Polyline3D object to an empty polygon.

Methods inherited from class java.lang.Object

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

Field Detail

npoints

public int npoints

The total number of points. The value of npoints represents the number of points in this Polyline3D.

xpoints

public double[] xpoints

The array of x coordinates. The value of npoints is equal to the number of points in this Polyline3D.

ypoints

public double[] ypoints

The array of y coordinates. The value of npoints is equal to the number of points in this Polyline3D.

zpoints

public double[] zpoints

The array of z coordinates. The value of npoints is equal to the number of points in this Polyline3D.

Constructor Detail

Polyline3D

public Polyline3D()

Creates an empty Polyline3D.

Polyline3D

public Polyline3D(double[] xpoints,
          double[] ypoints,
          double[] zpoints,
          int npoints)

Constructs and initializes a Polyline3D from the specified parameters.

Parameters:

xpoints - an array of x coordinates

ypoints - an array of y coordinates

zpoints - an array of z coordinates

npoints - the total number of points in the Polyline3D

Throws:

java.lang.NegativeArraySizeException - if the value of npoints is negative.

java.lang.IndexOutOfBoundsException - if npoints is greater than the length of points array.

java.lang.NullPointerException - if one of the points array is null.

Polyline3D

public Polyline3D(int[] xpoints,
          int[] ypoints,
          int[] zpoints,
          int npoints)

Constructs and initializes a Polyline3D from the specified parameters.

Parameters:

xpoints - an array of x coordinates

ypoints - an array of y coordinates

zpoints - an array of z coordinates

npoints - the total number of points in the Polyline3D

Throws:

java.lang.NegativeArraySizeException - if the value of npoints is negative.

java.lang.IndexOutOfBoundsException - if npoints is greater than the length of points array.

java.lang.NullPointerException - if one of the points array is null.

Polyline3D

public Polyline3D(Line3D line)

Method Detail

reset

public void reset()

Resets this Polyline3D object to an empty polygon. The coordinate arrays and the data in them are left untouched but the number of points is reset to zero to mark the old vertex data as invalid and to start accumulating new vertex data at the beginning. All internally-cached data relating to the old vertices are discarded. Note that since the coordinate arrays from before the reset are reused, creating a new empty Polyline3D might be more memory efficient than resetting the current one if the number of vertices in the new polyline data is significantly smaller than the number of vertices in the data from before the reset.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

calculateLines

public void calculateLines()

addPoint

public void addPoint(Point3D p)

Appends the specified coordinates to this Polyline3D.

If an operation that calculates the bounding box of this Polyline3D has already been performed, such as getBounds or contains, then this method updates the bounding box.

Parameters:

p - the point to add

addPoint

public void addPoint(double x,
            double y,
            double z)

Appends the specified coordinates to this Polyline3D.

If an operation that calculates the bounding box of this Polyline3D has already been performed, such as getBounds or contains, then this method updates the bounding box.

Parameters:

x - the specified x coordinate

y - the specified y coordinate

z - the specified z coordinate

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.

contains

public boolean contains(Point3D p)

Description copied from interface: Shape3D

Tests if a specified Point3D is inside the boundary of the Shape3D.

Specified by:

contains in interface Shape3D

Parameters:

p - the specified Point3D to be tested

Returns:

true if the specified Point3D is inside the boundary of the Shape3D; false otherwise.

contains

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

Description copied from interface: Shape3D

Tests if the specified 3D coordinates are inside the boundary of the Shape3D.

Specified by:

contains in interface Shape3D

Parameters:

x - the specified X coordinate to be tested

y - the specified Y coordinate to be tested

z - the specified Z coordinate to be tested

Returns:

true if the specified coordinates are inside the Shape3D boundary; false otherwise.

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)

contains

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

Description copied from interface: Shape3D

Tests if the interior of the Shape3D entirely contains the specified 3D rectangular area. All coordinates that lie inside the 3D rectangular area must lie within the Shape3D for the entire 3D rectangular area to be considered contained within the Shape3D.

The Shape3D.contains() method allows a Shape3D implementation to conservatively return false when:

• the intersect method returns true and
• the calculations to determine whether or not the Shape3D entirely contains the 3D rectangular area are prohibitively expensive.

This means that for some Shapes this method might return false even though the Shape3D contains the 3D rectangular 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:

true if the interior of the Shape3D entirely contains the specified rectangular area; false otherwise or, if the Shape3D contains the 3D rectangular area and the intersects method returns true and the containment calculations would be too expensive to perform.

contains

public boolean contains(Rectangle3D r)

Description copied from interface: Shape3D

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

• the intersect method returns true and
• the calculations to determine whether or not the Shape3D entirely contains the Rectangle3D are prohibitively expensive.

This means that for some Shapes this method might return false even though the Shape3D contains the Rectangle3D.

Specified by:

contains in interface Shape3D

Parameters:

r - The specified Rectangle3D

Returns:

true if the interior of the Shape3D entirely contains the Rectangle3D; false otherwise or, if the Shape3D contains the Rectangle3D and the intersects method returns true and the containment calculations would be too expensive to perform.

See Also:

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