Point (Revolution Systems Open Library TRUNK-SNAPSHOT API)

All Superinterfaces:

Cloneable, Comparable<Object>, DataTypeProxy, Geometry, Puntal, Serializable

All Known Subinterfaces:

Vertex

All Known Implementing Classes:

AbstractPoint, AbstractVertex, Circle, GeometryCollectionVertex, LineStringVertex, MultiLineStringVertex, MultiPointVertex, MultiPolygonVertex, Node, PointDouble, PointDouble2D, PointDoubleGf, PointVertex, PointWithOrientation, PolygonVertex, PreparedPoint
```
public interface Point
extends Geometry, Puntal, Serializable
```
Represents a single point. A Point is topologically valid if and only if:
- the coordinate which defines it (if any) is a valid coordinate (i.e does not have an NaN X or Y ordinate)
Version:

1.7

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`NULL_ORDINATE` The value used to indicate a null or missing ordinate value.
`static int`	`X` Standard ordinate index values
`static int`	`Y`
`static int`	`Z`

Fields inherited from interface com.revolsys.jts.geom.Geometry
M, sortedGeometryTypes

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`angle2d(Point other)` Calculate the counter clockwise angle in radians of the vector from this point to another point.
`Point`	`clone()` Creates and returns a full copy of this `Point` object.
`Point`	`clonePoint()`
`int`	`compareTo(Object o)` Compares this `Coordinates` with the specified `Coordinates` for order.
`void`	`copyCoordinates(GeometryFactory geometryFactory, double[] coordinates)`
`double`	`distance(double x, double y)`
`double`	`distance(Point point)` Computes the 2-dimensional Euclidean distance to another location.
`double`	`distance3d(Point c)` Computes the 3-dimensional Euclidean distance to another location.
`boolean`	`equals(double... coordinates)`
`boolean`	`equals(Point point)`
`boolean`	`equals2d(Point point, double tolerance)` Tests if another coordinate has the same values for the X and Y ordinates.
`double`	`getCoordinate(int axisIndex)` Gets the ordinate value for the given index.
`double[]`	`getCoordinates()`
`double`	`getM()`
`long`	`getTime()`
`double`	`getX()`
`double`	`getY()`
`double`	`getZ()`
`Point`	`move(double... deltas)`
`Point`	`normalize()` Converts this `Geometry` to normal form (or canonical form ).
`Point`	`prepare()`

Methods inherited from interface com.revolsys.jts.geom.Geometry
appendVertex, buffer, buffer, buffer, compareToSameClass, contains, containsProperly, convert, convert, convexHull, copy, coveredBy, covers, crosses, deleteVertex, difference, disjoint, distance, equal, equals, equals, equals, equalsExact, equalsExact, equalsNorm, equalsTopo, geometries, getArea, getAxisCount, getBoundary, getBoundaryDimension, getBoundingBox, getCentroid, getClassSortIndex, getCoordinateSystem, getDimension, getEnvelope, getGeometries, getGeometries, getGeometry, getGeometryComponents, getGeometryCount, getGeometryFactory, getGeometryType, getInteriorPoint, getLength, getPoint, getPointWithin, getSegment, getSrid, getToVertex, getUserData, getVertex, getVertexCount, hashCode, hasInvalidXyCoordinates, insertVertex, intersection, intersects, intersects, isEmpty, isRectangle, isSimple, isValid, isWithinDistance, moveVertex, overlaps, relate, relate, reverse, segments, setUserData, symDifference, toClockwise, toCounterClockwise, touches, toWkt, union, union, vertices, within

Methods inherited from interface com.revolsys.data.types.DataTypeProxy
getDataType

- Field Detail
  - NULL_ORDINATE
```
static final double NULL_ORDINATE
```
    The value used to indicate a null or missing ordinate value. In particular, used for the value of ordinates for dimensions greater than the defined dimension of a coordinate.
    
    See Also:
    Constant Field Values
  - X
```
static final int X
```
    Standard ordinate index values
    
    See Also:
    Constant Field Values
  - Y
```
static final int Y
```
    See Also:
    Constant Field Values
  - Z
```
static final int Z
```
    See Also:
    Constant Field Values
- Method Detail
  - angle2d
```
double angle2d(Point other)
```
    Calculate the counter clockwise angle in radians of the vector from this point to another point. The angle is relative to the positive x-axis relative to the positive X-axis. The angle will be in the range -PI -> PI where negative values have a clockwise orientation.
    
    Returns:
    The angle in radians.
  - clone
```
Point clone()
```
    Creates and returns a full copy of this Point object. (including all coordinates contained by it).
    
    Specified by:
    
    clone in interface Geometry
    
    Returns:
    a clone of this instance
  - clonePoint
```
Point clonePoint()
```
  - compareTo
```
int compareTo(Object o)
```
    Compares this Coordinates with the specified Coordinates for order. This method ignores the z value when making the comparison. Returns:
    - -1 : this.x < other.x || ((this.x == other.x) && (this.y < other.y))
    - 0 : this.x == other.x && this.y = other.y
    - 1 : this.x > other.x || ((this.x == other.x) && (this.y > other.y))
    Note: This method assumes that ordinate values are valid numbers. NaN values are not handled correctly.
    Specified by:
    
    compareTo in interface Comparable<Object>
    
    Specified by:
    
    compareTo in interface Geometry
    
    Parameters:
    o - the Coordinate with which this Coordinate is being compared
    
    Returns:
    -1, zero, or 1 as this Coordinate is less than, equal to, or greater than the specified Coordinate
  - copyCoordinates
```
void copyCoordinates(GeometryFactory geometryFactory,
                   double[] coordinates)
```
  - distance
```
double distance(double x,
              double y)
```
  - distance
```
double distance(Point point)
```
    Computes the 2-dimensional Euclidean distance to another location. The Z-ordinate is ignored.
    
    Parameters:
    c - a point
    
    Returns:
    the 2-dimensional Euclidean distance between the locations
  - distance3d
```
double distance3d(Point c)
```
    Computes the 3-dimensional Euclidean distance to another location.
    
    Parameters:
    c - a coordinate
    
    Returns:
    the 3-dimensional Euclidean distance between the locations
  - equals
```
boolean equals(double... coordinates)
```
  - equals
```
boolean equals(Point point)
```
  - equals2d
```
boolean equals2d(Point point,
               double tolerance)
```
    Tests if another coordinate has the same values for the X and Y ordinates. The Z ordinate is ignored.
    
    Parameters:
    other - a Coordinate with which to do the 2D comparison.
    
    Returns:
    true if other is a Coordinate with the same values for X and Y.
  - getCoordinate
```
double getCoordinate(int axisIndex)
```
    Gets the ordinate value for the given index. The supported values for the index are X, Y, and Z.
    
    Parameters:
    axisIndex - the ordinate index
    
    Returns:
    the value of the ordinate
    
    Throws:
    
    IllegalArgumentException - if the index is not valid
  - getCoordinates
```
double[] getCoordinates()
```
  - getM
```
double getM()
```
  - getTime
```
long getTime()
```
  - getX
```
double getX()
```
  - getY
```
double getY()
```
  - getZ
```
double getZ()
```
  - move
```
Point move(double... deltas)
```
    Specified by:
    
    move in interface Geometry
  - normalize
```
Point normalize()
```
    Description copied from interface: Geometry
    
    Converts this Geometry to normal form (or canonical form ). Normal form is a unique representation for Geometry s. It can be used to test whether two Geometrys are equal in a way that is independent of the ordering of the coordinates within them. Normal form equality is a stronger condition than topological equality, but weaker than pointwise equality. The definitions for normal form use the standard lexicographical ordering for coordinates. "Sorted in order of coordinates" means the obvious extension of this ordering to sequences of coordinates.
    
    Specified by:
    
    normalize in interface Geometry
    
    Returns:
    a normalized copy of this geometry.
    See Also:
    Geometry.normalize()
  - prepare
```
Point prepare()
```
    Specified by:
    
    prepare in interface Geometry

Interface Point

Field Summary

Fields inherited from interface com.revolsys.jts.geom.Geometry

Method Summary

Methods inherited from interface com.revolsys.jts.geom.Geometry

Methods inherited from interface com.revolsys.data.types.DataTypeProxy

Field Detail

NULL_ORDINATE

X

Y

Z

Method Detail

angle2d

clone

clonePoint

compareTo

copyCoordinates

distance

distance

distance3d

equals

equals

equals2d

getCoordinate

getCoordinates

getM

getTime

getX

getY

getZ

move

normalize

prepare