CoordinateXYZM

@SerialVersionUID(-8763329985881823442L) class CoordinateXYZM(xArg: Double, yArg: Double, zArg: Double, var m: Double) extends Coordinate

Coordinate subclass supporting XYZM ordinates.

This data object is suitable for use with coordinate sequences with <tt>dimension</tt> = 4 and <tt>measures</tt> = 1.

Since

1.16

trait Serializable
trait Cloneable
trait Comparable[Coordinate]
class Object
trait Matchable
class Any

Value members

Constructors

def this(coord: Coordinate)

Constructs a CoordinateXYZM instance with the ordinates of the given Coordinate.

Constructs a CoordinateXYZM instance with the ordinates of the given Coordinate.

Value Params
coord

the coordinate providing the ordinates

def this(coord: CoordinateXYZM)

Constructs a CoordinateXYZM instance with the ordinates of the given CoordinateXYZM.

Constructs a CoordinateXYZM instance with the ordinates of the given CoordinateXYZM.

Value Params
coord

the coordinate providing the ordinates

Concrete methods

override def copy: Coordinate

Creates a copy of this CoordinateXYZM.

Creates a copy of this CoordinateXYZM.

return a copy of this CoordinateXYZM

Definition Classes
override def getM: Double

The m-measure, if available.

The m-measure, if available.

Definition Classes
@nowarn
override def getOrdinate(ordinateIndex: Int): Double
Definition Classes
override def setCoordinate(other: Coordinate): Unit
Definition Classes
override def setM(m: Double): Unit
Definition Classes
override def setOrdinate(ordinateIndex: Int, value: Double): Unit
Definition Classes
override def toString: String
Definition Classes
Coordinate -> Any

Inherited methods

override def clone: Coordinate
Definition Classes
Coordinate -> Object
Inherited from
Coordinate
override def compareTo(o: Coordinate): Int

Compares this {link Coordinate} with the specified {link Coordinate} for order. This method ignores the z value when making the comparison. Returns:

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 &lt; other.x || ((this.x == other.x) &amp;&amp; (this.y &lt; other.y)) <LI> 0 : this.x == other.x &amp;&amp; this.y = other.y <LI> 1 : this.x &gt; other.x || ((this.x == other.x) &amp;&amp; (this.y &gt; other.y))

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

Value Params
o

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

Definition Classes
Coordinate -> Comparable
Inherited from
Coordinate
def distance(c: Coordinate): Double

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

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

Value Params
c

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

Inherited from
Coordinate
def distance3D(c: Coordinate): Double

Computes the 3-dimensional Euclidean distance to another location.

Computes the 3-dimensional Euclidean distance to another location.

Value Params
c

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

Inherited from
Coordinate
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.

Value Params
c

a coordinate

tolerance

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

Inherited from
Coordinate
override def equals(other: Any): Boolean

Returns <code>true</code> if <code>other</code> 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.

Returns <code>true</code> if <code>other</code> 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.

Value Params
other

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

Definition Classes
Coordinate -> Any
Inherited from
Coordinate
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. The Z ordinate is ignored.

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

Value Params
c

a <code>Coordinate</code> with which to do the 2D comparison.

tolerance

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

Inherited from
Coordinate
def equals2D(other: Coordinate): Boolean

Returns whether the planar projections of the two <code>Coordinate</code>s are equal.

Returns whether the planar projections of the two <code>Coordinate</code>s are equal.

Value Params
other

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

Inherited from
Coordinate
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.

Value Params
other

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

Inherited from
Coordinate
def getX: Double

Retrieves the value of the X ordinate.

Retrieves the value of the X ordinate.

return the value of the X ordinate

Inherited from
Coordinate
def getY: Double

Retrieves the value of the Y ordinate.

Retrieves the value of the Y ordinate.

return the value of the Y ordinate

Inherited from
Coordinate
def getZ: Double

Retrieves the value of the Z ordinate, if present. If no Z value is present returns <tt>NaN</tt>.

Retrieves the value of the Z ordinate, if present. If no Z value is present returns <tt>NaN</tt>.

return the value of the Z ordinate, or <tt>NaN</tt>

Inherited from
Coordinate
override def hashCode: Int

Gets a hashcode for this coordinate.

Gets a hashcode for this coordinate.

return a hashcode for this coordinate

Definition Classes
Coordinate -> Any
Inherited from
Coordinate
def setX(x: Double): Unit

Sets the X ordinate value.

Sets the X ordinate value.

Value Params
x

the value to set as X

Inherited from
Coordinate
def setY(y: Double): Unit

Sets the Y ordinate value.

Sets the Y ordinate value.

Value Params
y

the value to set as Y

Inherited from
Coordinate
def setZ(z: Double): Unit

Sets the Z ordinate value.

Sets the Z ordinate value.

Value Params
z

the value to set as Z

Inherited from
Coordinate

Concrete fields

var m: Double

Inherited fields

var x: Double
Inherited from
Coordinate
var y: Double
Inherited from
Coordinate
var z: Double
Inherited from
Coordinate