class Envelope extends Comparable[Envelope] with Serializable

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

Instance Constructors

  1. new Envelope(env: Envelope)

    Create an Envelope from an existing Envelope.

    Create an Envelope from an existing Envelope.

    env

    the Envelope to initialize from

  2. new Envelope(p: Coordinate)

    Creates an Envelope for a region defined by a single Coordinate.

    Creates an Envelope for a region defined by a single Coordinate.

    p

    the Coordinate

  3. new Envelope(p1: Coordinate, p2: Coordinate)

    Creates an Envelope for a region defined by two Coordinates.

    Creates an Envelope for a region defined by two Coordinates.

    p1

    the first Coordinate

    p2

    the second Coordinate

  4. new Envelope(x1: Double, x2: Double, y1: Double, y2: Double)

    Creates an Envelope for a region defined by maximum and minimum values.

    Creates an Envelope for a region defined by maximum and minimum values.

    x1

    the first x-value

    x2

    the second x-value

    y1

    the first y-value

    y2

    the second y-value

  5. new Envelope()

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 centre: Coordinate

    Computes the coordinate of the centre of this envelope (as long as it is non-null

    Computes the coordinate of the centre of this envelope (as long as it is non-null

    return the centre coordinate of this envelope null if the envelope is null

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. def compareTo(o: Envelope): Int

    Compares two envelopes using lexicographic ordering.

    Compares two envelopes using lexicographic ordering. The ordering comparison is based on the usual numerical comparison between the sequence of ordinates. Null envelopes are less than all non-null envelopes.

    o

    an Envelope object

    Definition Classes
    Envelope → Comparable
  8. def contains(x: Double, y: Double): Boolean

    Tests if the given point lies in or on the envelope.

    Tests if the given point lies in or on the envelope.

    Note that this is not the same definition as the SFS contains, which would exclude the envelope boundary.

    x

    the x-coordinate of the point which this Envelope is being checked for containing

    y

    the y-coordinate of the point which this Envelope is being checked for containing return true if (x, y) lies in the interior or on the boundary of this Envelope.

    See also

    #covers(double, double)

  9. def contains(p: Coordinate): Boolean

    Tests if the given point lies in or on the envelope.

    Tests if the given point lies in or on the envelope.

    Note that this is not the same definition as the SFS contains, which would exclude the envelope boundary.

    p

    the point which this Envelope is being checked for containing return true if the point lies in the interior or on the boundary of this Envelope.

    See also

    #covers(Coordinate)

  10. def contains(other: Envelope): Boolean

    Tests if the Envelope other lies wholely inside this Envelope (inclusive of the boundary).

    Tests if the Envelope other lies wholely inside this Envelope (inclusive of the boundary).

    Note that this is not the same definition as the SFS contains, which would exclude the envelope boundary.

    other

    the Envelope to check return true if other is contained in this Envelope

    See also

    #covers(Envelope)

  11. def copy: Envelope

    Creates a copy of this envelope object.

    Creates a copy of this envelope object.

    return a copy of this envelope

  12. def covers(other: Envelope): Boolean

    Tests if the Envelope other lies wholely inside this Envelope (inclusive of the boundary).

    Tests if the Envelope other lies wholely inside this Envelope (inclusive of the boundary).

    other

    the Envelope to check return true if this Envelope covers the other

  13. def covers(p: Coordinate): Boolean

    Tests if the given point lies in or on the envelope.

    Tests if the given point lies in or on the envelope.

    p

    the point which this Envelope is being checked for containing return true if the point lies in the interior or on the boundary of this Envelope.

  14. def covers(x: Double, y: Double): Boolean

    Tests if the given point lies in or on the envelope.

    Tests if the given point lies in or on the envelope.

    x

    the x-coordinate of the point which this Envelope is being checked for containing

    y

    the y-coordinate of the point which this Envelope is being checked for containing return true if (x, y) lies in the interior or on the boundary of this Envelope.

  15. def disjoint(other: Envelope): Boolean

    Tests if the region defined by other is disjoint from the region of this Envelope.

    Tests if the region defined by other is disjoint from the region of this Envelope.

    other

    the Envelope being checked for disjointness return true if the Envelopes are disjoint

    See also

    #intersects(Envelope)

  16. def distance(env: Envelope): Double

    Computes the distance between this and another Envelope.

    Computes the distance between this and another Envelope. The distance between overlapping Envelopes is 0. Otherwise, the distance is the Euclidean distance between the closest points.

  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(other: Any): Boolean
    Definition Classes
    Envelope → AnyRef → Any
  19. def expandBy(deltaX: Double, deltaY: Double): Unit

    Expands this envelope by a given distance in all directions.

    Expands this envelope by a given distance in all directions. Both positive and negative distances are supported.

    deltaX

    the distance to expand the envelope along the the X axis

    deltaY

    the distance to expand the envelope along the the Y axis

  20. def expandBy(distance: Double): Unit

    Expands this envelope by a given distance in all directions.

    Expands this envelope by a given distance in all directions. Both positive and negative distances are supported.

    distance

    the distance to expand the envelope

  21. def expandToInclude(other: Envelope): Unit

    Enlarges this Envelope so that it contains the other Envelope.

    Enlarges this Envelope so that it contains the other Envelope. Has no effect if other is wholly on or within the envelope.

    other

    the Envelope to expand to include

  22. def expandToInclude(x: Double, y: Double): Unit

    Enlarges this Envelope so that it contains the given point.

    Enlarges this Envelope so that it contains the given point. Has no effect if the point is already on or within the envelope.

    x

    the value to lower the minimum x to or to raise the maximum x to

    y

    the value to lower the minimum y to or to raise the maximum y to

  23. def expandToInclude(p: Coordinate): Unit

    Enlarges this Envelope so that it contains the given {link Coordinate}.

    Enlarges this Envelope so that it contains the given {link Coordinate}. Has no effect if the point is already on or within the envelope.

    p

    the Coordinate to expand to include

  24. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  25. def getArea: Double

    Gets the area of this envelope.

    Gets the area of this envelope.

    return the area of the envelope return 0.0 if the envelope is null

  26. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def getDiameter: Double

    Gets the length of the diameter (diagonal) of the envelope.

    Gets the length of the diameter (diagonal) of the envelope.

    return the diameter length

  28. def getHeight: Double

    Returns the difference between the maximum and minimum y values.

    Returns the difference between the maximum and minimum y values.

    return max y - min y, or 0 if this is a null Envelope

  29. def getMaxX: Double

    Returns the Envelopes maximum x-value.

    Returns the Envelopes maximum x-value. min x > max x indicates that this is a null Envelope.

    return the maximum x-coordinate

  30. def getMaxY: Double

    Returns the Envelopes maximum y-value.

    Returns the Envelopes maximum y-value. min y > max y indicates that this is a null Envelope.

    return the maximum y-coordinate

  31. def getMinX: Double

    Returns the Envelopes minimum x-value.

    Returns the Envelopes minimum x-value. min x > max x indicates that this is a null Envelope.

    return the minimum x-coordinate

  32. def getMinY: Double

    Returns the Envelopes minimum y-value.

    Returns the Envelopes minimum y-value. min y > max y indicates that this is a null Envelope.

    return the minimum y-coordinate

  33. def getWidth: Double

    Returns the difference between the maximum and minimum x values.

    Returns the difference between the maximum and minimum x values.

    return max x - min x, or 0 if this is a null Envelope

  34. def hashCode(): Int
    Definition Classes
    Envelope → AnyRef → Any
  35. def init(env: Envelope): Unit

    Initialize an Envelope from an existing Envelope.

    Initialize an Envelope from an existing Envelope.

    env

    the Envelope to initialize from

  36. def init(p: Coordinate): Unit

    Initialize an Envelope to a region defined by a single Coordinate.

    Initialize an Envelope to a region defined by a single Coordinate.

    p

    the coordinate

  37. def init(p1: Coordinate, p2: Coordinate): Unit

    Initialize an Envelope to a region defined by two Coordinates.

    Initialize an Envelope to a region defined by two Coordinates.

    p1

    the first Coordinate

    p2

    the second Coordinate

  38. def init(x1: Double, x2: Double, y1: Double, y2: Double): Unit

    Initialize an Envelope for a region defined by maximum and minimum values.

    Initialize an Envelope for a region defined by maximum and minimum values.

    x1

    the first x-value

    x2

    the second x-value

    y1

    the first y-value

    y2

    the second y-value

  39. def init(): Unit

    Initialize to a null Envelope.

  40. def intersection(env: Envelope): Envelope

    Computes the intersection of two {link Envelope}s.

    Computes the intersection of two {link Envelope}s.

    env

    the envelope to intersect with return a new Envelope representing the intersection of the envelopes (this will be the null envelope if either argument is null, or they do not intersect

  41. def intersects(x: Double, y: Double): Boolean

    Check if the point (x, y) intersects (lies inside) the region of this Envelope.

    Check if the point (x, y) intersects (lies inside) the region of this Envelope.

    x

    the x-ordinate of the point

    y

    the y-ordinate of the point return true if the point overlaps this Envelope

  42. def intersects(p: Coordinate): Boolean

    Tests if the point p intersects (lies inside) the region of this Envelope.

    Tests if the point p intersects (lies inside) the region of this Envelope.

    p

    the Coordinate to be tested return true if the point intersects this Envelope

  43. def intersects(a: Coordinate, b: Coordinate): Boolean

    Tests if the extent defined by two extremal points intersects the extent of this Envelope.

    Tests if the extent defined by two extremal points intersects the extent of this Envelope.

    a

    a point

    b

    another point return true if the extents intersect

  44. def intersects(other: Envelope): Boolean

    Tests if the region defined by other intersects the region of this Envelope.

    Tests if the region defined by other intersects the region of this Envelope.

    other

    the Envelope which this Envelope is being checked for intersecting return true if the Envelopes intersect

  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def isNull: Boolean

    Returns true if this Envelope is a "null" envelope.

    Returns true if this Envelope is a "null" envelope.

    return true if this Envelope is uninitialized or is the envelope of the empty geometry.

  47. def maxExtent: Double

    Gets the maximum extent of this envelope across both dimensions.

    Gets the maximum extent of this envelope across both dimensions.

    return the maximum extent of this envelope

  48. def minExtent: Double

    Gets the minimum extent of this envelope across both dimensions.

    Gets the minimum extent of this envelope across both dimensions.

    return the minimum extent of this envelope

  49. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  50. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  51. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. def overlaps(x: Double, y: Double): Boolean
  53. def setToNull(): Unit

    Makes this Envelope a "null" envelope, that is, the envelope of the empty geometry.

  54. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  55. def toString(): String
    Definition Classes
    Envelope → AnyRef → Any
  56. def translate(transX: Double, transY: Double): Unit

    Translates this envelope by given amounts in the X and Y direction.

    Translates this envelope by given amounts in the X and Y direction.

    transX

    the amount to translate along the X axis

    transY

    the amount to translate along the Y axis

  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  59. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def overlaps(p: Coordinate): Boolean

    Deprecated

    Use #intersects instead.

  2. def overlaps(other: Envelope): Boolean

    Deprecated

    Use #intersects instead. In the future, #overlaps may be changed to be a true overlap check; that is, whether the intersection is two-dimensional.

Inherited from Serializable

Inherited from Comparable[Envelope]

Inherited from AnyRef

Inherited from Any

Ungrouped