AxisPlaneCoordinateSequence (org.locationtech.jts:jts-core 1.16.1 API)

java.lang.Object
- org.locationtech.jts.operation.distance3d.AxisPlaneCoordinateSequence

All Implemented Interfaces:

Cloneable, CoordinateSequence
```
public class AxisPlaneCoordinateSequence
extends Object
implements CoordinateSequence
```
A CoordinateSequence wrapper which projects 3D coordinates into one of the three Cartesian axis planes, using the standard orthonormal projection (i.e. simply selecting the appropriate ordinates into the XY ordinates). The projected data is represented as 2D coordinates.

Author:

mdavis

Field Summary
- Fields inherited from interface org.locationtech.jts.geom.CoordinateSequence
  M, X, Y, Z

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone()` Returns a deep copy of this collection.
`AxisPlaneCoordinateSequence`	`copy()` Returns a deep copy of this collection.
`Envelope`	`expandEnvelope(Envelope env)` Expands the given `Envelope` to include the coordinates in the sequence.
`Coordinate`	`getCoordinate(int i)` Returns (possibly a copy of) the i'th coordinate in this sequence.
`void`	`getCoordinate(int index, Coordinate coord)` Copies the i'th coordinate in the sequence to the supplied `Coordinate`.
`Coordinate`	`getCoordinateCopy(int i)` Returns a copy of the i'th coordinate in this sequence.
`int`	`getDimension()` Returns the dimension (number of ordinates in each coordinate) for this sequence.
`double`	`getOrdinate(int index, int ordinateIndex)` Returns the ordinate of a coordinate in this sequence.
`double`	`getX(int index)` Returns ordinate X (0) of the specified coordinate.
`double`	`getY(int index)` Returns ordinate Y (1) of the specified coordinate.
`double`	`getZ(int index)` Returns ordinate Z of the specified coordinate if available.
`static CoordinateSequence`	`projectToXY(CoordinateSequence seq)` Creates a wrapper projecting to the XY plane.
`static CoordinateSequence`	`projectToXZ(CoordinateSequence seq)` Creates a wrapper projecting to the XZ plane.
`static CoordinateSequence`	`projectToYZ(CoordinateSequence seq)` Creates a wrapper projecting to the YZ plane.
`void`	`setOrdinate(int index, int ordinateIndex, double value)` Sets the value for a given ordinate of a coordinate in this sequence.
`int`	`size()` Returns the number of coordinates in this sequence.
`Coordinate[]`	`toCoordinateArray()` Returns (possibly copies of) the Coordinates in this collection.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.locationtech.jts.geom.CoordinateSequence
createCoordinate, getM, getMeasures, hasM, hasZ

- Method Detail
  - projectToXY
```
public static CoordinateSequence projectToXY(CoordinateSequence seq)
```
    Creates a wrapper projecting to the XY plane.
    
    Parameters:
    
    seq - the sequence to be projected
    
    Returns:
    
    a sequence which projects coordinates
  - projectToXZ
```
public static CoordinateSequence projectToXZ(CoordinateSequence seq)
```
    Creates a wrapper projecting to the XZ plane.
    
    Parameters:
    
    seq - the sequence to be projected
    
    Returns:
    
    a sequence which projects coordinates
  - projectToYZ
```
public static CoordinateSequence projectToYZ(CoordinateSequence seq)
```
    Creates a wrapper projecting to the YZ plane.
    
    Parameters:
    
    seq - the sequence to be projected
    
    Returns:
    
    a sequence which projects coordinates
  - getDimension
```
public int getDimension()
```
    Description copied from interface: CoordinateSequence
    
    Returns the dimension (number of ordinates in each coordinate) for this sequence.
    This total includes any measures, indicated by non-zero CoordinateSequence.getMeasures().
    
    Specified by:
    
    getDimension in interface CoordinateSequence
    
    Returns:
    
    the dimension of the sequence.
  - getCoordinate
```
public Coordinate getCoordinate(int i)
```
    Description copied from interface: CoordinateSequence
    
    Returns (possibly a copy of) the i'th coordinate in this sequence. Whether or not the Coordinate returned is the actual underlying Coordinate or merely a copy depends on the implementation.
    Note that in the future the semantics of this method may change to guarantee that the Coordinate returned is always a copy. Callers should not to assume that they can modify a CoordinateSequence by modifying the object returned by this method.
    
    Specified by:
    
    getCoordinate in interface CoordinateSequence
    
    Parameters:
    
    i - the index of the coordinate to retrieve
    
    Returns:
    
    the i'th coordinate in the sequence
  - getCoordinateCopy
```
public Coordinate getCoordinateCopy(int i)
```
    Description copied from interface: CoordinateSequence
    
    Returns a copy of the i'th coordinate in this sequence. This method optimizes the situation where the caller is going to make a copy anyway - if the implementation has already created a new Coordinate object, no further copy is needed.
    
    Specified by:
    
    getCoordinateCopy in interface CoordinateSequence
    
    Parameters:
    
    i - the index of the coordinate to retrieve
    
    Returns:
    
    a copy of the i'th coordinate in the sequence
  - getCoordinate
```
public void getCoordinate(int index,
                          Coordinate coord)
```
    Description copied from interface: CoordinateSequence
    
    Copies the i'th coordinate in the sequence to the supplied Coordinate. Only the first two dimensions are copied.
    
    Specified by:
    
    getCoordinate in interface CoordinateSequence
    
    Parameters:
    
    index - the index of the coordinate to copy
    
    coord - a Coordinate to receive the value
  - getX
```
public double getX(int index)
```
    Description copied from interface: CoordinateSequence
    
    Returns ordinate X (0) of the specified coordinate.
    
    Specified by:
    
    getX in interface CoordinateSequence
    
    Returns:
    
    the value of the X ordinate in the index'th coordinate
  - getY
```
public double getY(int index)
```
    Description copied from interface: CoordinateSequence
    
    Returns ordinate Y (1) of the specified coordinate.
    
    Specified by:
    
    getY in interface CoordinateSequence
    
    Returns:
    
    the value of the Y ordinate in the index'th coordinate
  - getZ
```
public double getZ(int index)
```
    Description copied from interface: CoordinateSequence
    
    Returns ordinate Z of the specified coordinate if available.
    
    Specified by:
    
    getZ in interface CoordinateSequence
    
    Returns:
    
    the value of the Z ordinate in the index'th coordinate, or Double.NaN if not defined.
  - getOrdinate
```
public double getOrdinate(int index,
                          int ordinateIndex)
```
    Description copied from interface: CoordinateSequence
    
    Returns the ordinate of a coordinate in this sequence. Ordinate indices 0 and 1 are assumed to be X and Y.
    Ordinates indices greater than 1 have user-defined semantics (for instance, they may contain other dimensions or measure values as described by CoordinateSequence.getDimension() and CoordinateSequence.getMeasures()).
    
    Specified by:
    
    getOrdinate in interface CoordinateSequence
    
    Parameters:
    
    index - the coordinate index in the sequence
    
    ordinateIndex - the ordinate index in the coordinate (in range [0, dimension-1])
  - size
```
public int size()
```
    Description copied from interface: CoordinateSequence
    
    Returns the number of coordinates in this sequence.
    
    Specified by:
    
    size in interface CoordinateSequence
    
    Returns:
    
    the size of the sequence
  - setOrdinate
```
public void setOrdinate(int index,
                        int ordinateIndex,
                        double value)
```
    Description copied from interface: CoordinateSequence
    
    Sets the value for a given ordinate of a coordinate in this sequence.
    
    Specified by:
    
    setOrdinate in interface CoordinateSequence
    
    Parameters:
    
    index - the coordinate index in the sequence
    
    ordinateIndex - the ordinate index in the coordinate (in range [0, dimension-1])
    
    value - the new ordinate value
  - toCoordinateArray
```
public Coordinate[] toCoordinateArray()
```
    Description copied from interface: CoordinateSequence
    
    Returns (possibly copies of) the Coordinates in this collection. Whether or not the Coordinates returned are the actual underlying Coordinates or merely copies depends on the implementation. Note that if this implementation does not store its data as an array of Coordinates, this method will incur a performance penalty because the array needs to be built from scratch.
    
    Specified by:
    
    toCoordinateArray in interface CoordinateSequence
    
    Returns:
    
    a array of coordinates containing the point values in this sequence
  - expandEnvelope
```
public Envelope expandEnvelope(Envelope env)
```
    Description copied from interface: CoordinateSequence
    
    Expands the given Envelope to include the coordinates in the sequence. Allows implementing classes to optimize access to coordinate values.
    
    Specified by:
    
    expandEnvelope in interface CoordinateSequence
    
    Parameters:
    
    env - the envelope to expand
    
    Returns:
    
    a ref to the expanded envelope
  - clone
```
public Object clone()
```
    Description copied from interface: CoordinateSequence
    
    Returns a deep copy of this collection. Called by Geometry#clone.
    
    Specified by:
    
    clone in interface CoordinateSequence
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a copy of the coordinate sequence containing copies of all points
  - copy
```
public AxisPlaneCoordinateSequence copy()
```
    Description copied from interface: CoordinateSequence
    
    Returns a deep copy of this collection.
    
    Specified by:
    
    copy in interface CoordinateSequence
    
    Returns:
    
    a copy of the coordinate sequence containing copies of all points

Class AxisPlaneCoordinateSequence

Field Summary

Fields inherited from interface org.locationtech.jts.geom.CoordinateSequence

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.locationtech.jts.geom.CoordinateSequence

Method Detail

projectToXY

projectToXZ

projectToYZ

getDimension

getCoordinate

getCoordinateCopy

getCoordinate

getX

getY

getZ

getOrdinate

size

setOrdinate

toCoordinateArray

expandEnvelope

clone

copy