Package org.geotools.geometry
Class Position3D
Object
Position3D
- All Implemented Interfaces:
Serializable
,Cloneable
,Position
,Cloneable
Holds the coordinates for a three-dimensional position within some coordinate reference system.
- Author:
- Niels Charlier
- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a position initialized to (0,0,0) with anull
coordinate reference system.Position3D
(double x, double y, double z) Constructs a 3D position from the specified ordinates.Position3D
(Position point) Constructs a position initialized to the same values than the specified point.Constructs a position with the specified coordinate reference system.Position3D
(CoordinateReferenceSystem crs, double x, double y, double z) Constructs a 2D position from the specified ordinates in the specified CRS. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a clone of this point.boolean
Compares this point with the specified object for equality.double[]
Returns a sequence of numbers that hold the coordinate of this position in its reference system.Returns the coordinate reference system in which the coordinate is given.final int
The length of coordinate sequence (the number of entries).Returns alwaysthis
, the direct position for this position.final double
getOrdinate
(int dimension) Returns the ordinate at the specified dimension.int
hashCode()
Returns a hash value for this coordinate.void
Set the coordinate reference system in which the coordinate is given.void
setLocation
(Position position) Set this coordinate to the specified direct position.final void
setOrdinate
(int dimension, double value) Sets the ordinate value along the specified dimension.toString()
Returns a string representation of this coordinate.
-
Field Details
-
x
public double x -
y
public double y -
z
public double z
-
-
Constructor Details
-
Position3D
public Position3D()Constructs a position initialized to (0,0,0) with anull
coordinate reference system. -
Position3D
Constructs a position with the specified coordinate reference system.- Parameters:
crs
- The coordinate reference system, ornull
.
-
Position3D
public Position3D(double x, double y, double z) Constructs a 3D position from the specified ordinates.- Parameters:
x
- The x value.y
- The y value.z
- The z value.
-
Position3D
Constructs a 2D position from the specified ordinates in the specified CRS.- Parameters:
crs
- The coordinate reference system, ornull
.x
- The x value.y
- The y value.z
- The z value.
-
Position3D
Constructs a position initialized to the same values than the specified point.- Parameters:
point
- The point to copy.
-
-
Method Details
-
getDirectPosition
Returns alwaysthis
, the direct position for this position.- Specified by:
getDirectPosition
in interfacePosition
- Returns:
- The direct position (may be
this
).
-
getCoordinateReferenceSystem
Returns the coordinate reference system in which the coordinate is given. May benull
if this particularDirectPosition
is included in a larger object with such a reference to a coordinate reference system.- Specified by:
getCoordinateReferenceSystem
in interfacePosition
- Returns:
- The coordinate reference system, or
null
.
-
setCoordinateReferenceSystem
Set the coordinate reference system in which the coordinate is given.- Parameters:
crs
- The new coordinate reference system, ornull
.
-
getDimension
public final int getDimension()The length of coordinate sequence (the number of entries). This is always 3 forDirectPosition3D
objects.- Specified by:
getDimension
in interfacePosition
- Returns:
- The dimensionality of this position.
-
getCoordinate
public double[] getCoordinate()Returns a sequence of numbers that hold the coordinate of this position in its reference system.- Specified by:
getCoordinate
in interfacePosition
- Returns:
- The coordinates
-
getOrdinate
Returns the ordinate at the specified dimension.- Specified by:
getOrdinate
in interfacePosition
- Parameters:
dimension
- The dimension in the range 0 to 2 inclusive.- Returns:
- The coordinate at the specified dimension.
- Throws:
IndexOutOfBoundsException
- if the specified dimension is out of bounds.
-
setOrdinate
Sets the ordinate value along the specified dimension.- Specified by:
setOrdinate
in interfacePosition
- Parameters:
dimension
- the dimension for the ordinate of interest.value
- the ordinate value of interest.- Throws:
IndexOutOfBoundsException
- if the specified dimension is out of bounds.
-
setLocation
Set this coordinate to the specified direct position. If the specified position contains a coordinate reference system, then the CRS for this position will be set to the CRS of the specified position.- Parameters:
position
- The new position for this point.- Throws:
MismatchedDimensionException
- if this point doesn't have the expected dimension.
-
toString
Returns a string representation of this coordinate. -
hashCode
public int hashCode()Returns a hash value for this coordinate. This method implements thePosition.hashCode()
contract. -
equals
Compares this point with the specified object for equality. If the given object implements thePosition
interface, then the comparison is performed as specified in itsPosition.equals(java.lang.Object)
contract. -
clone
Returns a clone of this point.
-