Spatial DataBlade
JAVA API v8.21

com.ibm.spatial.geom
Class Envelope.Double

java.lang.Object
  extended by com.ibm.spatial.geom.Envelope
      extended by com.ibm.spatial.geom.Envelope.Double
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Enclosing class:
Envelope

public static class Envelope.Double
extends Envelope

The Double class defines a shape envelope specified in double coordinates.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.ibm.spatial.geom.Envelope
Envelope.Double, Envelope.Long
 
Field Summary
 double maxM
          The maximum measure of this Envelope.
 double maxX
          The maximum x coordinate of this Envelope.
 double maxY
          The maximum y coordinate of this Envelope.
 double maxZ
          The maximum z coordinate of this Envelope.
 double minM
          The minimum measure of this Envelope.
 double minX
          The minimum x coordinate of this Envelope.
 double minY
          The minimum y coordinate of this Envelope.
 double minZ
          The minimum z coordinate of this Envelope.
 
Constructor Summary
Envelope.Double()
          Constructs a new 2D (no z coordinate and measure) Envelope, where minimum values are larger than maximums (empty envelope).
Envelope.Double(double minX, double minY, double maxX, double maxY)
          Constructs and initializes a Envelope from the specified coordinates.
 
Method Summary
 Envelope createIntersection(Envelope e)
          Returns a new Envelope object representing the intersection of this Envelope with the specified Envelope.
 Envelope createUnion(Envelope e)
          Returns a new Envelope object representing the union of this Envelope with the specified Envelope.
 double getMaxM()
          Returns the maximum Y coordinate of this Envelope in double precision.
 double getMaxX()
          Returns the maximum X coordinate of this Envelope in double precision.
 double getMaxY()
          Returns the maximum Y coordinate of this Envelope in double precision.
 double getMaxZ()
          Returns the maximum Z coordinate of this Envelope in double precision.
 double getMinM()
          Returns the minimum measure of this Envelope in double precision.
 double getMinX()
          Returns the minimum X coordinate of this Envelope in double precision.
 double getMinY()
          Returns the minimum Y coordinate of this Envelope in double precision.
 double getMinZ()
          Returns the minimum Z coordinate of this Envelope in double precision.
 boolean hasM()
          Determines whether or not this Envelope haz M extent.
 boolean hasZ()
          Determines whether or not this Envelope haz Z extent.
 boolean isEmpty()
          Determines whether or not this 2D Envelope is empty.
 void setEmpty()
          Sets this Envelope to empty (no extent).
 void setExtent(double minX, double minY, double maxX, double maxY)
          Sets the extent of this Envelope to the specified values.
 void setExtent(Envelope e)
          Sets this Envelope to be the same as the specified Envelope.
 void setExtentM(double minM, double maxM)
          Sets the extent of the measure of this Envelope to the specified values.
 void setExtentZ(double minZ, double maxZ)
          Sets the extent of the Z coordinate of this Envelope to the specified values.
 java.lang.String toString()
          Returns the String representation of this Envelope.
 
Methods inherited from class com.ibm.spatial.geom.Envelope
add, add, add, add, addM, addM, addZ, addZ, clone, equals, getCenter, getCenter, getMax, getMin, hashCode, intersect, intersects, union
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

minX

public double minX
The minimum x coordinate of this Envelope.


minY

public double minY
The minimum y coordinate of this Envelope.


maxX

public double maxX
The maximum x coordinate of this Envelope.


maxY

public double maxY
The maximum y coordinate of this Envelope.


minZ

public double minZ
The minimum z coordinate of this Envelope.


maxZ

public double maxZ
The maximum z coordinate of this Envelope.


minM

public double minM
The minimum measure of this Envelope.


maxM

public double maxM
The maximum measure of this Envelope.

Constructor Detail

Envelope.Double

public Envelope.Double()
Constructs a new 2D (no z coordinate and measure) Envelope, where minimum values are larger than maximums (empty envelope).


Envelope.Double

public Envelope.Double(double minX,
                       double minY,
                       double maxX,
                       double maxY)
Constructs and initializes a Envelope from the specified coordinates. If the minimum values are larger than the maximum values the envelope is defined as empty.

Parameters:
minX, maxX - the minimum/maximum x coordinate values of the newly constructed Envelope
minY, maxY - the minimum/maximum y coordinate values of the newly constructed Envelope
Method Detail

getMinX

public double getMinX()
Returns the minimum X coordinate of this Envelope in double precision.

Specified by:
getMinX in class Envelope
Returns:
the minimum X coordinate of this Envelope.

getMaxX

public double getMaxX()
Returns the maximum X coordinate of this Envelope in double precision.

Specified by:
getMaxX in class Envelope
Returns:
the maximum X coordinate of this Envelope.

getMinY

public double getMinY()
Returns the minimum Y coordinate of this Envelope in double precision.

Specified by:
getMinY in class Envelope
Returns:
the minimum Y coordinate of this Envelope.

getMaxY

public double getMaxY()
Returns the maximum Y coordinate of this Envelope in double precision.

Specified by:
getMaxY in class Envelope
Returns:
the maximum Y coordinate of this Envelope.

getMinZ

public double getMinZ()
Returns the minimum Z coordinate of this Envelope in double precision.

Specified by:
getMinZ in class Envelope
Returns:
the minimum Z coordinate of this Envelope.

getMaxZ

public double getMaxZ()
Returns the maximum Z coordinate of this Envelope in double precision.

Specified by:
getMaxZ in class Envelope
Returns:
the maximum Z coordinate of this Envelope.

getMinM

public double getMinM()
Returns the minimum measure of this Envelope in double precision.

Specified by:
getMinM in class Envelope
Returns:
the minimum measure of this Envelope.

getMaxM

public double getMaxM()
Returns the maximum Y coordinate of this Envelope in double precision.

Specified by:
getMaxM in class Envelope
Returns:
the maximum Y coordinate of this Envelope.

setExtent

public void setExtent(double minX,
                      double minY,
                      double maxX,
                      double maxY)
Sets the extent of this Envelope to the specified values.

Specified by:
setExtent in class Envelope
Parameters:
minX, maxX - the minimum/maximum x coordinate values
minY, maxY - the minimum/maximum y coordinate values

setExtentZ

public void setExtentZ(double minZ,
                       double maxZ)
Sets the extent of the Z coordinate of this Envelope to the specified values.

Specified by:
setExtentZ in class Envelope
Parameters:
minZ, maxZ - the minimum/maximum Z coordinate values

setExtentM

public void setExtentM(double minM,
                       double maxM)
Sets the extent of the measure of this Envelope to the specified values.

Specified by:
setExtentM in class Envelope
Parameters:
minM, maxM - the minimum/maximum measure values

setExtent

public void setExtent(Envelope e)
Sets this Envelope to be the same as the specified Envelope.

Overrides:
setExtent in class Envelope
Parameters:
e - the specified Envelope

hasZ

public boolean hasZ()
Determines whether or not this Envelope haz Z extent.

Specified by:
hasZ in class Envelope
Returns:
true if this Envelope has a Z extent; false otherwise.

hasM

public boolean hasM()
Determines whether or not this Envelope haz M extent.

Specified by:
hasM in class Envelope
Returns:
true if this Envelope has an M extent; false otherwise.

isEmpty

public boolean isEmpty()
Determines whether or not this 2D Envelope is empty.

Specified by:
isEmpty in class Envelope
Returns:
true if this Envelope is empty; false otherwise.

setEmpty

public void setEmpty()
Sets this Envelope to empty (no extent).

Specified by:
setEmpty in class Envelope

createIntersection

public Envelope createIntersection(Envelope e)
Returns a new Envelope object representing the intersection of this Envelope with the specified Envelope.

Specified by:
createIntersection in class Envelope
Parameters:
e - the Envelope that is intersected with this Envelope
Returns:
the largest Envelope contained in both the specified Envelope and in this Envelope.

createUnion

public Envelope createUnion(Envelope e)
Returns a new Envelope object representing the union of this Envelope with the specified Envelope.

Specified by:
createUnion in class Envelope
Parameters:
r - the Envelope to be combined with this Envelope
Returns:
the smallest Envelope containing both the specified Envelope and this Envelope.

toString

public java.lang.String toString()
Returns the String representation of this Envelope.

Overrides:
toString in class java.lang.Object
Returns:
a String representing this Envelope.

Spatial DataBlade
JAVA API v8.21


Licensed Materials - Property of IBM
Copyright IBM Corp. 2002, 2012 All Rights Reserved.