com.esri.arcgis.geometry
Interface IEnvelope

All Superinterfaces:

IGeometry, Serializable

All Known Subinterfaces:

IEnvelope2

All Known Implementing Classes:

Envelope

Deprecated. This interface uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by IEnvelopeGEN. You can use the GEN interface proxy's Object-constructor to cast an instance of this interface to its GEN equivalent. Any ArcGIS class that implements this interface also implements the GEN interface.

public interface IEnvelope
extends IGeometry, Serializable

Provides access to methods and properties of envelopes.

Superseded By

IEnvelope2

Description

Envelopes are the rectangular window that contain a specific element. All Geometry objects have an envelope defined by the XMin, XMax, YMin, and YMax of the object. Envelopes can also serve as the viewing area for a particular view screen or data frame.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

IPoint, IGeometry

Method Summary

void	centerAt(IPoint p) Deprecated. Moves this envelope so it is centered at p.
void	defineFromPoints(int count, IPoint points) Deprecated. Defines the envelope to cover all the points.
void	expand(double dx, double dy, boolean asRatio) Deprecated. Moves the X and Y coordinates of the sides toward or away from each other.
void	expandM(double dm, boolean asRatio) Deprecated. Moves the measure of the sides toward or away from each other.
void	expandZ(double dz, boolean asRatio) Deprecated. Moves the Z attribute of the sides toward or away from each other.
double	getDepth() Deprecated. The depth of the envelope.
double	getHeight() Deprecated. The height of the envelope.
IPoint	getLowerLeft() Deprecated. The lower left corner.
IPoint	getLowerRight() Deprecated. The lower right corner.
double	getMMax() Deprecated. The maximum measure value in the area of the envelope.
double	getMMin() Deprecated. The minimum measure value in the area of the envelope.
IPoint	getUpperLeft() Deprecated. The upper left corner.
IPoint	getUpperRight() Deprecated. The upper right corner.
double	getWidth() Deprecated. The width of the envelope.
double	getXMax() Deprecated. The position of the right side.
double	getXMin() Deprecated. The position of the left side.
double	getYMax() Deprecated. The position of the top.
double	getYMin() Deprecated. The position of the bottom.
double	getZMax() Deprecated. The maximum Z value in the area of the envelope.
double	getZMin() Deprecated. The minimum Z value in the area of the envelope.
void	intersect(IEnvelope inEnvelope) Deprecated. Adjusts to include only the area also included by inEnvelope.
void	offset(double x, double y) Deprecated. Moves the sides x units horizontally and y units vertically.
void	offsetM(double m) Deprecated. Moves the sides m units.
void	offsetZ(double z) Deprecated. Moves the sides z units.
void	putCoords(double xMin, double yMin, double xMax, double yMax) Deprecated. Constructs an envelope from the coordinate values of lower, left and upper, right corners.
void	queryCoords(double[] xMin, double[] yMin, double[] xMax, double[] yMax) Deprecated. Returns the coordinates of lower, left and upper, right corners.
void	setDepth(double depth) Deprecated. The depth of the envelope.
void	setHeight(double height) Deprecated. The height of the envelope.
void	setLowerLeft(IPoint lowerLeft) Deprecated. The lower left corner.
void	setLowerRight(IPoint lowerRight) Deprecated. The lower right corner.
void	setMMax(double mMax) Deprecated. The maximum measure value in the area of the envelope.
void	setMMin(double mMin) Deprecated. The minimum measure value in the area of the envelope.
void	setUpperLeft(IPoint upperLeft) Deprecated. The upper left corner.
void	setUpperRight(IPoint upperRight) Deprecated. The upper right corner.
void	setWidth(double width) Deprecated. The width of the envelope.
void	setXMax(double xMax) Deprecated. The position of the right side.
void	setXMin(double xMin) Deprecated. The position of the left side.
void	setYMax(double yMax) Deprecated. The position of the top.
void	setYMin(double yMin) Deprecated. The position of the bottom.
void	setZMax(double zMax) Deprecated. The maximum Z value in the area of the envelope.
void	setZMin(double zMin) Deprecated. The minimum Z value in the area of the envelope.
void	union(IEnvelope inEnvelope) Deprecated. Adjusts to overlap inEnvelope.

Methods inherited from interface com.esri.arcgis.geometry.IGeometry

geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference

Method Detail

getWidth

double getWidth()
                throws IOException,
                       AutomationException

Deprecated.

The width of the envelope.

Description

The Width of an Envelope is the horizonal span. The Width = XMax - XMin. Used to get or set the Width of a non-empty Envelope. If used to set the Width, the LowerLeft and UpperLeft points are preserved and the LowerRight and UpperRight points are repositioned accordingly.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getUpperLeft(), IEnvelope.getHeight(), IEnvelope.getLowerLeft(), IEnvelope.getLowerRight()

setWidth

void setWidth(double width)
              throws IOException,
                     AutomationException

Deprecated.

The width of the envelope.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

width - The width (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

double getHeight()
                 throws IOException,
                        AutomationException

Deprecated.

The height of the envelope.

Description

The Height of an Envelope is the vertical span. The Height = YMax - YMin. Used to get or set the Height of a non-empty Envelope. If used to set the Height, the LowerLeft and LowerRight points are preserved and the UpperLeft and UpperRight points are repositioned accordingly.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getWidth(), IEnvelope.getUpperLeft(), IEnvelope.getLowerLeft(), IEnvelope.getLowerRight(), IEnvelope.getUpperRight()

setDepth

void setDepth(double depth)
              throws IOException,
                     AutomationException

Deprecated.

The depth of the envelope.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

depth - The depth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepth

double getDepth()
                throws IOException,
                       AutomationException

Deprecated.

The depth of the envelope.

Description

The Depth of an Envelope is the range of Z values. The Depth = ZMax - ZMin. Used to get or set the Depth of a non-empty Envelope. The Envelope must be ZAware and have non-NaN Zs set.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The depth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

void setHeight(double height)
               throws IOException,
                      AutomationException

Deprecated.

The height of the envelope.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

height - The height (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowerLeft

IPoint getLowerLeft()
                    throws IOException,
                           AutomationException

Deprecated.

The lower left corner.

Remarks

Returns or sets the LowerLeft point of an Envelope .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getWidth(), IEnvelope.getUpperLeft(), IEnvelope.getHeight(), IEnvelope.getLowerRight(), IEnvelope.getUpperRight()

setLowerLeft

void setLowerLeft(IPoint lowerLeft)
                  throws IOException,
                         AutomationException

Deprecated.

The lower left corner.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

lowerLeft - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpperLeft

IPoint getUpperLeft()
                    throws IOException,
                           AutomationException

Deprecated.

The upper left corner.

Remarks

Returns or sets the UpperLeft point of an Envelope .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getWidth(), IEnvelope.getHeight(), IEnvelope.getLowerLeft(), IEnvelope.getLowerRight(), IEnvelope.getUpperRight()

setUpperLeft

void setUpperLeft(IPoint upperLeft)
                  throws IOException,
                         AutomationException

Deprecated.

The upper left corner.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

upperLeft - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpperRight

IPoint getUpperRight()
                     throws IOException,
                            AutomationException

Deprecated.

The upper right corner.

Description

private void printEnvelope(IEnvelope envelope)
{
IPoint lowerLeft = envelope.LowerLeft;
IPoint lowerRight = envelope.LowerRight;
IPoint upperLeft = envelope.UpperLeft;
IPoint upperRight = envelope.UpperRight;

String report = "LowerLeft X = " + lowerLeft.X + "\n" +
"LowerLeft Y = " + lowerLeft.Y + "\n\n" +
"LowerRight X = " + lowerRight.X + "\n" +
"LowerRight Y = " + lowerRight.Y + "\n\n" +
"UpperLeft X = " + upperLeft.X + "\n" +
"UpperLeft Y = " + upperLeft.Y + "\n\n" +
"UpperRight X = " + upperRight.X + "\n" +
"UpperRight Y = " + upperRight.Y;

System.Windows.Forms.MessageBox.Show(report);
}

Remarks

Returns or sets the UpperRight point of an Envelope .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getWidth(), IEnvelope.getUpperLeft(), IEnvelope.getHeight(), IEnvelope.getLowerLeft(), IEnvelope.getLowerRight()

setUpperRight

void setUpperRight(IPoint upperRight)
                   throws IOException,
                          AutomationException

Deprecated.

The upper right corner.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

upperRight - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowerRight

IPoint getLowerRight()
                     throws IOException,
                            AutomationException

Deprecated.

The lower right corner.

Description

private void printEnvelope(IEnvelope envelope)
{
IPoint lowerLeft = envelope.LowerLeft;
IPoint lowerRight = envelope.LowerRight;
IPoint upperLeft = envelope.UpperLeft;
IPoint upperRight = envelope.UpperRight;

String report = "LowerLeft X = " + lowerLeft.X + "\n" +
"LowerLeft Y = " + lowerLeft.Y + "\n\n" +
"LowerRight X = " + lowerRight.X + "\n" +
"LowerRight Y = " + lowerRight.Y + "\n\n" +
"UpperLeft X = " + upperLeft.X + "\n" +
"UpperLeft Y = " + upperLeft.Y + "\n\n" +
"UpperRight X = " + upperRight.X + "\n" +
"UpperRight Y = " + upperRight.Y;

System.Windows.Forms.MessageBox.Show(report);
}

Remarks

Returns or sets the LowerRight point of an Envelope .

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.geometry.IPoint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getWidth(), IEnvelope.getUpperLeft(), IEnvelope.getHeight(), IEnvelope.getLowerLeft(), IEnvelope.getUpperRight()

setLowerRight

void setLowerRight(IPoint lowerRight)
                   throws IOException,
                          AutomationException

Deprecated.

The lower right corner.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

lowerRight - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXMin

double getXMin()
               throws IOException,
                      AutomationException

Deprecated.

The position of the left side.

Description

XMin is the left side coordinate of the envelope.

Remarks

Setting Xmin to a value larger than Xmax will reverse Xmin and Xmax. Use PutCoords to avoid this behavior.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The xMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getYMin(), IEnvelope.getXMax()

setXMin

void setXMin(double xMin)
             throws IOException,
                    AutomationException

Deprecated.

The position of the left side.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

xMin - The xMin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYMin

double getYMin()
               throws IOException,
                      AutomationException

Deprecated.

The position of the bottom.

Description

YMin is the bottom coordinate of the envelope.

Remarks

Setting Ymin to a value larger than Ymax will reverse Ymin and Ymax. Use PutCoords to avoid this behavior.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The yMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getXMin(), IEnvelope.getXMax()

setYMin

void setYMin(double yMin)
             throws IOException,
                    AutomationException

Deprecated.

The position of the bottom.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

yMin - The yMin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXMax

double getXMax()
               throws IOException,
                      AutomationException

Deprecated.

The position of the right side.

Description

XMax is the right side coordinate of the envelope.

Remarks

Setting Xmax to a value smaller than Xmin will reverse Xmin and Xmax. Use PutCoords to avoid this behavior.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The xMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getYMin(), IEnvelope.getXMin()

setXMax

void setXMax(double xMax)
             throws IOException,
                    AutomationException

Deprecated.

The position of the right side.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

xMax - The xMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYMax

double getYMax()
               throws IOException,
                      AutomationException

Deprecated.

The position of the top.

Description

YMax is the top coordinate of the envelope.

Remarks

Setting Ymax to a value smaller than Ymin will reverse Ymin and Ymax. Use PutCoords to avoid this behavior.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The yMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.getYMin(), IEnvelope.getXMin(), IEnvelope.getXMax()

setYMax

void setYMax(double yMax)
             throws IOException,
                    AutomationException

Deprecated.

The position of the top.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

yMax - The yMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMMin

double getMMin()
               throws IOException,
                      AutomationException

Deprecated.

The minimum measure value in the area of the envelope.

Description

MMin is the minimum M value for the object owning the envelope.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The mMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMMin

void setMMin(double mMin)
             throws IOException,
                    AutomationException

Deprecated.

The minimum measure value in the area of the envelope.

Example:

double dMmin = null;
IEnvelope pEnv = null;
pEnv = new Envelope() 
pEnv.setMMin(100.0);
dMmin = pEnv.getMMin();

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

mMin - The mMin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMMax

double getMMax()
               throws IOException,
                      AutomationException

Deprecated.

The maximum measure value in the area of the envelope.

Description

MMax is the maximum M value for the object owning the envelope.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The mMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMMax

void setMMax(double mMax)
             throws IOException,
                    AutomationException

Deprecated.

The maximum measure value in the area of the envelope.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

mMax - The mMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZMin

double getZMin()
               throws IOException,
                      AutomationException

Deprecated.

The minimum Z value in the area of the envelope.

Description

ZMin defines the lower elevation boundary of the envelope.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The zMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZMin

void setZMin(double zMin)
             throws IOException,
                    AutomationException

Deprecated.

The minimum Z value in the area of the envelope.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zMin - The zMin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZMax

double getZMax()
               throws IOException,
                      AutomationException

Deprecated.

The maximum Z value in the area of the envelope.

Description

ZMax defines the upper elevation boundary of the envelope.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:

The zMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZMax

void setZMax(double zMax)
             throws IOException,
                    AutomationException

Deprecated.

The maximum Z value in the area of the envelope.

Example:

double dZmax = null;
IEnvelope pEnv = null;
pEnv = new Envelope() 
pEnv.setZMax(100.0);
dMmin = pEnv.getZMax();

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

zMax - The zMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

union

void union(IEnvelope inEnvelope)
           throws IOException,
                  AutomationException

Deprecated.

Adjusts to overlap inEnvelope.

Description

Sets the Envelope equal to the union of the base Envelope and the input Envelope. The XMin and YMin of the resulting Envelope is the minimum XMin and YMin respectively between the base and input Envelopes, and the XMax and YMax of the resulting Envelope is the maximum XMax and YMax respectively between the base and input Envelopes.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

inEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.offset(double, double), IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint), IEnvelope.expand(double, double, boolean), IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope)

intersect

void intersect(IEnvelope inEnvelope)
               throws IOException,
                      AutomationException

Deprecated.

Adjusts to include only the area also included by inEnvelope.

Description

Sets the Envelope equal to the intersection of the base Envelope and the input Envelope. The XMin and YMin of the resulting Envelope is the maximum XMin and YMin respectively between the base and input Envelopes, and the XMax and YMax of the resulting Envelope is the minimum XMax and YMax respectively between the base and input Envelopes. If the resulting XMin > XMax, or YMin > YMax, then the Envelope is Empty (and all XMin, XMax, YMin, and YMax are undefined.).

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

inEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.offset(double, double), IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint), IEnvelope.expand(double, double, boolean), IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)

offset

void offset(double x,
            double y)
            throws IOException,
                   AutomationException

Deprecated.

Moves the sides x units horizontally and y units vertically.

Description

Offset moves the position of the Envelope. A positive X value will shift the Envelope to the right and a negative value to the left. A positive Y value will shift the Envelope up and a negative value down. The Width and Height of the Envelope remain unchanged. Only the XMin, YMin, XMax, and YMax are changed.

Remarks

The new position of the Envelope is as follows:

new XMin= old XMin + X
new YMin = old YMin + Y
new XMax = old XMax + X
new YMax = old YMax + Y

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

x - The x (in)

y - The y (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint), IEnvelope.expand(double, double, boolean), IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope), IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)

offsetZ

void offsetZ(double z)
             throws IOException,
                    AutomationException

Deprecated.

Moves the sides z units.

Description

OffsetZ shifts the Z attributes of the Envelope. The Depth remains unchanged.

Remarks

new ZMin = old ZMin + Z
new ZMax = old ZMax + Z

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

z - The z (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetM

void offsetM(double m)
             throws IOException,
                    AutomationException

Deprecated.

Moves the sides m units.

Description

OffsetM shifts the M values for the Envelope. None of the other properties are changed.

Remarks

new MMin = old MMin + M
new MMax = old MMax + M

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

m - The m (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expand

void expand(double dx,
            double dy,
            boolean asRatio)
            throws IOException,
                   AutomationException

Deprecated.

Moves the X and Y coordinates of the sides toward or away from each other.

Description

Expand scales the size of the Envelope. If asRatio = FALSE, the expansion is additive.

XMin = XMin - dx

YMin = YMin - dy

XMax = XMax + dx

YMax = YMax + dy

If asRatio = TRUE, the expansion is multiplicative. If the user wants to increase the envelope width by 10%, then dx = 1.1. On the other hand, if the user intends to decrease the width by 10%, then dx = 0.9. No negative number allowed when asRation is set to TRUE.

XMin = XMin - (dx-1)*Width/2

YMin = YMin - (dy-1)*Height/2 

XMax = XMax + (dx-1)*Width/2

YMax = YMax + (dy-1)*Height/2

The Envelope remains centered at the same position.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

dx - The dx (in)

dy - The dy (in)

asRatio - The asRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.offset(double, double), IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint), IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope), IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)

expandZ

void expandZ(double dz,
             boolean asRatio)
             throws IOException,
                    AutomationException

Deprecated.

Moves the Z attribute of the sides toward or away from each other.

Description

ExpandZ scales the Z attributes of the Envelope. If asRatio = FALSE, the scaling is additive (ZMin = ZMin - dz, ZMax = ZMax + dz). If asRatio = TRUE, the scaling is multiplicative (ZMin = ZMin - dz*Depth/2, ZMax = ZMax + dz*Depth/2)

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

dz - The dz (in)

asRatio - The asRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandM

void expandM(double dm,
             boolean asRatio)
             throws IOException,
                    AutomationException

Deprecated.

Moves the measure of the sides toward or away from each other.

Description

ExpandM scales the M attributes of the Envelope. If asRatio = FALSE, the scaling is additive (MMin = MMin - dm, MMax = MMax + dm). If asRatio = TRUE, the scaling is multiplicative (MMin = MMin - dm*(MMax - MMin)/2, MMax = MMax + dm*(MMax - MMin)/2).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

dm - The dm (in)

asRatio - The asRatio (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

defineFromPoints

void defineFromPoints(int count,
                      IPoint points)
                      throws IOException,
                             AutomationException

Deprecated.

Defines the envelope to cover all the points.

Description

Defines this Envelope from an array of Points. The XMin, YMin, XMax, and YMax correspond to the minimum X value, minimum Y value, maximum X value, and maximum Y value respectively of the the Points in the array.

Remarks

This is similar to getting the Envelope of a Multipoint.

Note: It is also possible to define a degenerate point Envelope by passing a single Point as an argument. The IPoint parameter accepts both a single IPoint object and an array of IPoints. To use an array, pass the desired starting element of the array as the input argument.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

count - The count (in)

points - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoords

void putCoords(double xMin,
               double yMin,
               double xMax,
               double yMax)
               throws IOException,
                      AutomationException

Deprecated.

Constructs an envelope from the coordinate values of lower, left and upper, right corners.

Description

Defines an Envelope given the XMin, YMin, XMax, and YMax. If XMin > XMax or if YMin > YMax, the created Envelope uses the input values, but properly reassigns the Min and Max values.

Remarks

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

xMin - The xMin (in)

yMin - The yMin (in)

xMax - The xMax (in)

yMax - The yMax (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.queryCoords(double[], double[], double[], double[])

queryCoords

void queryCoords(double[] xMin,
                 double[] yMin,
                 double[] xMax,
                 double[] yMax)
                 throws IOException,
                        AutomationException

Deprecated.

Returns the coordinates of lower, left and upper, right corners.

Description

Returns the XMin, YMin, XMax, and YMax values for the Envelope. These values can also be used to recreate the Envelope using PutCoords.

Example:

double dXmin[]= new double[1];
double dYmin[]= new double[1]; 
double dXmax[]= new double[1]; 
double dYmax[]= new double[1];
m_pEnveLope.queryCoords( dXmin, dYmin, dXmax, dYmax);

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

xMin - The xMin (out: use single element array)

yMin - The yMin (out: use single element array)

xMax - The xMax (out: use single element array)

yMax - The yMax (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.putCoords(double, double, double, double)

centerAt

void centerAt(IPoint p)
              throws IOException,
                     AutomationException

Deprecated.

Moves this envelope so it is centered at p.

Description

Moves the Envelope so that the center point of the Envelope is at the given input point. The Width, Height, and other properties of the Envelope remain unchanged (only the XMin, XMax, YMin, and YMax are altered).

Remarks

The Center Point occurs at: ((XMin + XMax) / 2, (YMin + YMax) / 2).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:

p - A reference to a com.esri.arcgis.geometry.IPoint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IEnvelope.offset(double, double), IEnvelope.expand(double, double, boolean), IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope), IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)