com.esri.arcgis.geometry
Interface IEnvelopeGEN

All Superinterfaces:

Serializable

All Known Implementing Classes:

Envelope

public interface IEnvelopeGEN
extends Serializable

OLE Automation compatibility interface for IEnvelope.

Description

The IEnvelopeGen methods are designed to comply with any programming languages supported in ARCObjects (ex: VB 6.0, C++, Java, VB.NET, C#...). For example, writing code using this interface in VB 6.0 may result in less rework in a migration to VB.NET.

Product Availability

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

Method Summary

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

Method Detail

defineFromWKSPoints

void defineFromWKSPoints(_WKSPoint[] wksPoints)
                         throws IOException,
                                AutomationException

Defines the envelope to cover all the points.

Description

Please see the DefineFromWKSPoints method of IEnvelope for more details

Product Availability

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

Parameters:

wksPoints - A Structure: com.esri.arcgis.system._WKSPoint (An array of com.esri.arcgis.system._WKSPoint COM typedef) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

defineFromPoints

void defineFromPoints(IPoint[] points)
                      throws IOException,
                             AutomationException

Defines the envelope to cover all the points.

Description

Please see the DefineFromPoints method of IEnvelope for more details

Product Availability

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

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

double getWidth()
                throws IOException,
                       AutomationException

The width of the envelope.

Description

refer to the Width property of IEnvelope

Product Availability

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

Returns:

The width

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

void setWidth(double width)
              throws IOException,
                     AutomationException

The width of the envelope.

Description

refer to the Width property of IEnvelope

Product Availability

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

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

The height of the envelope.

Description

refer to the Height property of IEnvelope

Product Availability

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

Returns:

The height

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDepth

void setDepth(double depth)
              throws IOException,
                     AutomationException

The depth of the envelope.

Description

refer to the Depth property of IEnvelope

Product Availability

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

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

The depth of the envelope.

Description

refer to the Depth property of IEnvelope

Product Availability

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

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

The height of the envelope.

Description

refer to the Height property of IEnvelope

Product Availability

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

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

The lower left corner.

Description

refer to the LowerLeft property of IEnvelope

Product Availability

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

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.

setLowerLeft

void setLowerLeft(IPoint lowerLeft)
                  throws IOException,
                         AutomationException

The lower left corner.

Description

refer to the LowerLeft property of IEnvelope

Product Availability

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

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

The upper left corner.

Description

refer to the UpperLeft property of IEnvelope

Product Availability

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

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.

setUpperLeft

void setUpperLeft(IPoint upperLeft)
                  throws IOException,
                         AutomationException

The upper left corner.

Description

refer to the UpperLeft property of IEnvelope

Product Availability

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

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

The upper right corner.

Description

refer to the UpperRight property of IEnvelope

Product Availability

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

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.

setUpperRight

void setUpperRight(IPoint upperRight)
                   throws IOException,
                          AutomationException

The upper right corner.

Description

refer to the UpperRight property of IEnvelope

Product Availability

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

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

The lower right corner.

Description

refer to the LowerRight property of IEnvelope

Product Availability

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

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.

setLowerRight

void setLowerRight(IPoint lowerRight)
                   throws IOException,
                          AutomationException

The lower right corner.

Description

refer to the LowerRight property of IEnvelope

Product Availability

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

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

The position of the left side.

Description

refer to the XMin property of IEnvelope

Product Availability

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

Returns:

The xMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXMin

void setXMin(double xMin)
             throws IOException,
                    AutomationException

The position of the left side.

Description

refer to the XMin property of IEnvelope

Product Availability

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

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

The position of the bottom.

Description

refer to the YMin property of IEnvelope

Product Availability

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

Returns:

The yMin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYMin

void setYMin(double yMin)
             throws IOException,
                    AutomationException

The position of the bottom.

Description

refer to the YMin property of IEnvelope

Product Availability

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

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

The position of the right side.

Description

refer to the XMax property of IEnvelope

Product Availability

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

Returns:

The xMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXMax

void setXMax(double xMax)
             throws IOException,
                    AutomationException

The position of the right side.

Description

refer to the XMax property of IEnvelope

Product Availability

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

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

The position of the top.

Description

refer to the YMax property of IEnvelope

Product Availability

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

Returns:

The yMax

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYMax

void setYMax(double yMax)
             throws IOException,
                    AutomationException

The position of the top.

Description

refer to the YMax property of IEnvelope

Product Availability

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

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

The minimum measure value in the area of the envelope.

Description

refer to the MMin property of IEnvelope

Product Availability

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

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

The minimum measure value in the area of the envelope.

Description

refer to the MMin property of IEnvelope

Product Availability

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

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

The maximum measure value in the area of the envelope.

Description

refer to the MMax property of IEnvelope

Product Availability

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

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

The maximum measure value in the area of the envelope.

Description

refer to the MMax property of IEnvelope

Product Availability

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

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

The minimum Z value in the area of the envelope.

Description

refer to the ZMin property of IEnvelope

Product Availability

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

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

The minimum Z value in the area of the envelope.

Description

refer to the ZMin property of IEnvelope

Product Availability

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

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

The maximum Z value in the area of the envelope.

Description

refer to the ZMax property of IEnvelope

Product Availability

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

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

The maximum Z value in the area of the envelope.

Description

refer to the ZMax property of IEnvelope

Product Availability

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

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

Adjusts to overlap inEnvelope.

Description

refer to the Union method of IEnvelope

Product Availability

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

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.

intersect

void intersect(IEnvelope inEnvelope)
               throws IOException,
                      AutomationException

Adjusts to include only the area also included by inEnvelope.

Description

refer to the Intersect method of IEnvelope

Product Availability

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

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.

offset

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

Moves the sides x units horizontally and y units vertically.

Description

refer to the Offset method of IEnvelope

Product Availability

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

Parameters:

x - The x (in)

y - The y (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetZ

void offsetZ(double z)
             throws IOException,
                    AutomationException

Moves the sides z units.

Description

refer to the OffsetZ method of IEnvelope

Product Availability

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

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

Moves the sides m units.

Description

refer to the OffsetM method of IEnvelope

Product Availability

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

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

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

Description

refer to the Expand method of IEnvelope

Product Availability

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

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.

expandZ

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

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

Description

refer to the ExpandZ method of IEnvelope

Product Availability

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

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

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

Description

refer to the ExpandM method of IEnvelope

Product Availability

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

Parameters:

dm - The dm (in)

asRatio - The asRatio (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

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

Description

refer to the PutCoords method of IEnvelope

Product Availability

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

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.

queryCoords

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

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

Description

refer to the QueryCoords method of IEnvelope

Product Availability

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

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.

centerAt

void centerAt(IPoint p)
              throws IOException,
                     AutomationException

Moves this envelope so it is centered at p.

Description

refer to the CenterAt method of IEnvelope

Product Availability

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

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.