class Coordinate extends Comparable[Coordinate] with Cloneable with Serializable

Annotations
@SerialVersionUID()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Coordinate
  2. Serializable
  3. Cloneable
  4. Comparable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Coordinate()

    Constructs a Coordinate at (0,0,NaN).

  2. new Coordinate(x: Double, y: Double)

    Constructs a Coordinate at (x,y,NaN).

    Constructs a Coordinate at (x,y,NaN).

    x

    the x-value

    y

    the y-value

  3. new Coordinate(c: Coordinate)

    Constructs a Coordinate having the same (x,y,z) values as other.

    Constructs a Coordinate having the same (x,y,z) values as other.

    c

    the Coordinate to copy.

  4. new Coordinate(x: Double, y: Double, z: Double)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): Coordinate
    Definition Classes
    Coordinate → AnyRef
  6. def compareTo(o: Coordinate): Int

    Compares this {link Coordinate} with the specified {link Coordinate} for order.

    Compares this {link Coordinate} with the specified {link Coordinate} for order. This method ignores the z value when making the comparison. Returns: <UL> <LI> -1 : this.x < other.x || ((this.x == other.x) && (this.y < other.y)) <LI> 0 : this.x == other.x && this.y = other.y <LI> 1 : this.x > other.x || ((this.x == other.x) && (this.y > other.y))

    </UL> Note: This method assumes that ordinate values are valid numbers. NaN values are not handled correctly.

    o

    the Coordinate with which this Coordinate is being compared return -1, zero, or 1 as this Coordinate is less than, equal to, or greater than the specified Coordinate

    Definition Classes
    Coordinate → Comparable
  7. def copy: Coordinate

    Creates a copy of this Coordinate.

    Creates a copy of this Coordinate.

    return a copy of this coordinate.

  8. def distance(c: Coordinate): Double

    Computes the 2-dimensional Euclidean distance to another location.

    Computes the 2-dimensional Euclidean distance to another location. The Z-ordinate is ignored.

    c

    a point return the 2-dimensional Euclidean distance between the locations

  9. def distance3D(c: Coordinate): Double

    Computes the 3-dimensional Euclidean distance to another location.

    Computes the 3-dimensional Euclidean distance to another location.

    c

    a coordinate return the 3-dimensional Euclidean distance between the locations

  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def equalInZ(c: Coordinate, tolerance: Double): Boolean

    Tests if another coordinate has the same value for Z, within a tolerance.

    Tests if another coordinate has the same value for Z, within a tolerance.

    c

    a coordinate

    tolerance

    the tolerance value return true if the Z ordinates are within the given tolerance

  12. def equals(other: Any): Boolean

    Returns true if other has the same values for the x and y ordinates.

    Returns true if other has the same values for the x and y ordinates. Since Coordinates are 2.5D, this routine ignores the z value when making the comparison.

    other

    a Coordinate with which to do the comparison. return true if other is a Coordinate with the same values for the x and y ordinates.

    Definition Classes
    Coordinate → AnyRef → Any
  13. def equals2D(c: Coordinate, tolerance: Double): Boolean

    Tests if another Coordinate has the same values for the X and Y ordinates, within a specified tolerance value.

    Tests if another Coordinate has the same values for the X and Y ordinates, within a specified tolerance value. The Z ordinate is ignored.

    c

    a Coordinate with which to do the 2D comparison.

    tolerance

    the tolerance value to use return true if other is a Coordinate with the same values for X and Y.

  14. def equals2D(other: Coordinate): Boolean

    Returns whether the planar projections of the two Coordinates are equal.

    Returns whether the planar projections of the two Coordinates are equal.

    other

    a Coordinate with which to do the 2D comparison. return true if the x- and y-coordinates are equal; the z-coordinates do not have to be equal.

  15. def equals3D(other: Coordinate): Boolean

    Tests if another coordinate has the same values for the X, Y and Z ordinates.

    Tests if another coordinate has the same values for the X, Y and Z ordinates.

    other

    a Coordinate with which to do the 3D comparison. return true if other is a Coordinate with the same values for X, Y and Z.

  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def getM: Double

    Retrieves the value of the measure, if present.

    Retrieves the value of the measure, if present. If no measure value is present returns NaN.

    return the value of the measure, or NaN

  19. def getOrdinate(ordinateIndex: Int): Double

    Gets the ordinate value for the given index.

    Gets the ordinate value for the given index.

    The base implementation supports values for the index are {link X}, {link Y}, and {link Z}.

    ordinateIndex

    the ordinate index return the value of the ordinate throws IllegalArgumentException if the index is not valid

  20. def getX: Double

    Retrieves the value of the X ordinate.

    Retrieves the value of the X ordinate.

    return the value of the X ordinate

  21. def getY: Double

    Retrieves the value of the Y ordinate.

    Retrieves the value of the Y ordinate.

    return the value of the Y ordinate

  22. def getZ: Double

    Retrieves the value of the Z ordinate, if present.

    Retrieves the value of the Z ordinate, if present. If no Z value is present returns NaN.

    return the value of the Z ordinate, or NaN

  23. def hashCode(): Int

    Gets a hashcode for this coordinate.

    Gets a hashcode for this coordinate.

    return a hashcode for this coordinate

    Definition Classes
    Coordinate → AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def setCoordinate(other: Coordinate): Unit

    Sets this Coordinates (x,y,z) values to that of other.

    Sets this Coordinates (x,y,z) values to that of other.

    other

    the Coordinate to copy

  29. def setM(m: Double): Unit

    Sets the measure value, if supported.

    Sets the measure value, if supported.

    m

    the value to set as M

  30. def setOrdinate(ordinateIndex: Int, value: Double): Unit

    Sets the ordinate for the given index to a given value.

    Sets the ordinate for the given index to a given value.

    The base implementation supported values for the index are {link X}, {link Y}, and {link Z}.

    ordinateIndex

    the ordinate index

    value

    the value to set throws IllegalArgumentException if the index is not valid

  31. def setX(x: Double): Unit

    Sets the X ordinate value.

    Sets the X ordinate value.

    x

    the value to set as X

  32. def setY(y: Double): Unit

    Sets the Y ordinate value.

    Sets the Y ordinate value.

    y

    the value to set as Y

  33. def setZ(z: Double): Unit

    Sets the Z ordinate value.

    Sets the Z ordinate value.

    z

    the value to set as Z

  34. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String

    Returns a String of the form <I>(x,y,z)</I> .

    Returns a String of the form <I>(x,y,z)</I> .

    return a String of the form <I>(x,y,z)</I>

    Definition Classes
    Coordinate → AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. var x: Double
  40. var y: Double
  41. var z: Double

Inherited from Serializable

Inherited from Cloneable

Inherited from Comparable[Coordinate]

Inherited from AnyRef

Inherited from Any

Ungrouped