com.esri.arcgis.geometry
Interface IEnvelopeGEN

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

Envelope, IEnvelopeGENProxy

public interface IEnvelopeGEN

extends java.io.Serializable

OLE Automation compatibility interface for IEnvelope.

Product Availability

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

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.

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

public void defineFromWKSPoints(_WKSPoint[] wksPoints)
                         throws java.io.IOException,
                                AutomationException

Defines the envelope to cover all the points.

Description

Please see the DefineFromWKSPoints method of IEnvelope for more details

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

defineFromPoints

public void defineFromPoints(IPoint[] points)
                      throws java.io.IOException,
                             AutomationException

Defines the envelope to cover all the points.

Description

Please see the DefineFromPoints method of IEnvelope for more details

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWidth

public double getWidth()
                throws java.io.IOException,
                       AutomationException

The width of the envelope.

Description

refer to the Width property of IEnvelope

Returns:

The width

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWidth

public void setWidth(double width)
              throws java.io.IOException,
                     AutomationException

The width of the envelope.

Description

refer to the Width property of IEnvelope

Parameters:

width - The width (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeight

public double getHeight()
                 throws java.io.IOException,
                        AutomationException

The height of the envelope.

Description

refer to the Height property of IEnvelope

Returns:

The height

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDepth

public void setDepth(double depth)
              throws java.io.IOException,
                     AutomationException

The depth of the envelope.

Description

refer to the Depth property of IEnvelope

Parameters:

depth - The depth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDepth

public double getDepth()
                throws java.io.IOException,
                       AutomationException

The depth of the envelope.

Description

refer to the Depth property of IEnvelope

Returns:

The depth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeight

public void setHeight(double height)
               throws java.io.IOException,
                      AutomationException

The height of the envelope.

Description

refer to the Height property of IEnvelope

Parameters:

height - The height (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowerLeft

public IPoint getLowerLeft()
                    throws java.io.IOException,
                           AutomationException

The lower left corner.

Description

refer to the LowerLeft property of IEnvelope

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowerLeft

public void setLowerLeft(IPoint lowerLeft)
                  throws java.io.IOException,
                         AutomationException

The lower left corner.

Description

refer to the LowerLeft property of IEnvelope

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpperLeft

public IPoint getUpperLeft()
                    throws java.io.IOException,
                           AutomationException

The upper left corner.

Description

refer to the UpperLeft property of IEnvelope

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpperLeft

public void setUpperLeft(IPoint upperLeft)
                  throws java.io.IOException,
                         AutomationException

The upper left corner.

Description

refer to the UpperLeft property of IEnvelope

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpperRight

public IPoint getUpperRight()
                     throws java.io.IOException,
                            AutomationException

The upper right corner.

Description

refer to the UpperRight property of IEnvelope

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpperRight

public void setUpperRight(IPoint upperRight)
                   throws java.io.IOException,
                          AutomationException

The upper right corner.

Description

refer to the UpperRight property of IEnvelope

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowerRight

public IPoint getLowerRight()
                     throws java.io.IOException,
                            AutomationException

The lower right corner.

Description

refer to the LowerRight property of IEnvelope

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowerRight

public void setLowerRight(IPoint lowerRight)
                   throws java.io.IOException,
                          AutomationException

The lower right corner.

Description

refer to the LowerRight property of IEnvelope

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXMin

public double getXMin()
               throws java.io.IOException,
                      AutomationException

The position of the left side.

Description

refer to the XMin property of IEnvelope

Returns:

The xMin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXMin

public void setXMin(double xMin)
             throws java.io.IOException,
                    AutomationException

The position of the left side.

Description

refer to the XMin property of IEnvelope

Parameters:

xMin - The xMin (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYMin

public double getYMin()
               throws java.io.IOException,
                      AutomationException

The position of the bottom.

Description

refer to the YMin property of IEnvelope

Returns:

The yMin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYMin

public void setYMin(double yMin)
             throws java.io.IOException,
                    AutomationException

The position of the bottom.

Description

refer to the YMin property of IEnvelope

Parameters:

yMin - The yMin (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXMax

public double getXMax()
               throws java.io.IOException,
                      AutomationException

The position of the right side.

Description

refer to the XMax property of IEnvelope

Returns:

The xMax

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXMax

public void setXMax(double xMax)
             throws java.io.IOException,
                    AutomationException

The position of the right side.

Description

refer to the XMax property of IEnvelope

Parameters:

xMax - The xMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYMax

public double getYMax()
               throws java.io.IOException,
                      AutomationException

The position of the top.

Description

refer to the YMax property of IEnvelope

Returns:

The yMax

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYMax

public void setYMax(double yMax)
             throws java.io.IOException,
                    AutomationException

The position of the top.

Description

refer to the YMax property of IEnvelope

Parameters:

yMax - The yMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMMin

public double getMMin()
               throws java.io.IOException,
                      AutomationException

The minimum measure value in the area of the envelope.

Description

refer to the MMin property of IEnvelope

Returns:

The mMin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMMin

public void setMMin(double mMin)
             throws java.io.IOException,
                    AutomationException

The minimum measure value in the area of the envelope.

Description

refer to the MMin property of IEnvelope

Parameters:

mMin - The mMin (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMMax

public double getMMax()
               throws java.io.IOException,
                      AutomationException

The maximum measure value in the area of the envelope.

Description

refer to the MMax property of IEnvelope

Returns:

The mMax

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMMax

public void setMMax(double mMax)
             throws java.io.IOException,
                    AutomationException

The maximum measure value in the area of the envelope.

Description

refer to the MMax property of IEnvelope

Parameters:

mMax - The mMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZMin

public double getZMin()
               throws java.io.IOException,
                      AutomationException

The minimum Z value in the area of the envelope.

Description

refer to the ZMin property of IEnvelope

Returns:

The zMin

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZMin

public void setZMin(double zMin)
             throws java.io.IOException,
                    AutomationException

The minimum Z value in the area of the envelope.

Description

refer to the ZMin property of IEnvelope

Parameters:

zMin - The zMin (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getZMax

public double getZMax()
               throws java.io.IOException,
                      AutomationException

The maximum Z value in the area of the envelope.

Description

refer to the ZMax property of IEnvelope

Returns:

The zMax

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setZMax

public void setZMax(double zMax)
             throws java.io.IOException,
                    AutomationException

The maximum Z value in the area of the envelope.

Description

refer to the ZMax property of IEnvelope

Parameters:

zMax - The zMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

union

public void union(IEnvelope inEnvelope)
           throws java.io.IOException,
                  AutomationException

Adjusts to overlap inEnvelope.

Description

refer to the Union method of IEnvelope

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersect

public void intersect(IEnvelope inEnvelope)
               throws java.io.IOException,
                      AutomationException

Adjusts to include only the area also included by inEnvelope.

Description

refer to the Intersect method of IEnvelope

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offset

public void offset(double x,
                   double y)
            throws java.io.IOException,
                   AutomationException

Moves the sides x units horizontally and y units vertically.

Description

refer to the Offset method of IEnvelope

Parameters:

x - The x (in)

y - The y (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetZ

public void offsetZ(double z)
             throws java.io.IOException,
                    AutomationException

Moves the sides z units.

Description

refer to the OffsetZ method of IEnvelope

Parameters:

z - The z (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetM

public void offsetM(double m)
             throws java.io.IOException,
                    AutomationException

Moves the sides m units.

Description

refer to the OffsetM method of IEnvelope

Parameters:

m - The m (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expand

public void expand(double dx,
                   double dy,
                   boolean asRatio)
            throws java.io.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

Parameters:

dx - The dx (in)

dy - The dy (in)

asRatio - The asRatio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandZ

public void expandZ(double dz,
                    boolean asRatio)
             throws java.io.IOException,
                    AutomationException

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

Description

refer to the ExpandZ method of IEnvelope

Parameters:

dz - The dz (in)

asRatio - The asRatio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

expandM

public void expandM(double dm,
                    boolean asRatio)
             throws java.io.IOException,
                    AutomationException

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

Description

refer to the ExpandM method of IEnvelope

Parameters:

dm - The dm (in)

asRatio - The asRatio (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

putCoords

public void putCoords(double xMin,
                      double yMin,
                      double xMax,
                      double yMax)
               throws java.io.IOException,
                      AutomationException

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

Description

refer to the PutCoords method of IEnvelope

Parameters:

xMin - The xMin (in)

yMin - The yMin (in)

xMax - The xMax (in)

yMax - The yMax (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryCoords

public void queryCoords(double[] xMin,
                        double[] yMin,
                        double[] xMax,
                        double[] yMax)
                 throws java.io.IOException,
                        AutomationException

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

Description

refer to the QueryCoords method of IEnvelope

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

centerAt

public void centerAt(IPoint p)
              throws java.io.IOException,
                     AutomationException

Moves this envelope so it is centered at p.

Description

refer to the CenterAt method of IEnvelope

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.