com.esri.arcgis.geometry

Interface IEnvelope

All Superinterfaces:

IGeometry, java.io.Serializable

All Known Subinterfaces:

IEnvelope2

All Known Implementing Classes:

Envelope, IEnvelope2Proxy, IEnvelopeProxy

public interface IEnvelope
extends IGeometry, java.io.Serializable

COM Interface 'IEnvelope'. Generated 9/21/2023 10:01:45 AM from 'X:\ArcGIS\com\server\esriGeometry.tlb'

Description: 'Provides access to methods and properties of envelopes.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID1b077914_38c5_11d0_92d2_00805f7c28b0
static int	xxDummy Deprecated. Internal use only

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

IID1b07790d_38c5_11d0_92d2_00805f7c28b0

Method Summary

Modifier and Type	Method and Description
void	centerAt(IPoint p) Moves this envelope so it is centered at p.
void	defineFromPoints(int count, IPoint points) 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.

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

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

Field Detail

IID1b077914_38c5_11d0_92d2_00805f7c28b0

static final int IID1b077914_38c5_11d0_92d2_00805f7c28b0

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getWidth

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

The width of the envelope.

Returns:

The width

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWidth

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

The width of the envelope.

Parameters:

width - The width (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeight

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

The height of the envelope.

Returns:

The height

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDepth

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

The depth of the envelope.

Parameters:

depth - The depth (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDepth

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

The depth of the envelope.

Returns:

The depth

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeight

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

The height of the envelope.

Parameters:

height - The height (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLowerLeft

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

The lower left corner.

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

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

The lower left corner.

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

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

The upper left corner.

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

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

The upper left corner.

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

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

The upper right corner.

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

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

The upper right corner.

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

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

The lower right corner.

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

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

The lower right corner.

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

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

The position of the left side.

Returns:

The xMin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXMin

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

The position of the left side.

Parameters:

xMin - The xMin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYMin

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

The position of the bottom.

Returns:

The yMin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYMin

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

The position of the bottom.

Parameters:

yMin - The yMin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getXMax

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

The position of the right side.

Returns:

The xMax

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setXMax

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

The position of the right side.

Parameters:

xMax - The xMax (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getYMax

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

The position of the top.

Returns:

The yMax

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setYMax

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

The position of the top.

Parameters:

yMax - The yMax (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMMin

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

The minimum measure value in the area of the envelope.

Returns:

The mMin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMMin

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

The minimum measure value in the area of the envelope.

Parameters:

mMin - The mMin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMMax

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

The maximum measure value in the area of the envelope.

Returns:

The mMax

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMMax

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

The maximum measure value in the area of the envelope.

Parameters:

mMax - The mMax (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZMin

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

The minimum Z value in the area of the envelope.

Returns:

The zMin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZMin

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

The minimum Z value in the area of the envelope.

Parameters:

zMin - The zMin (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getZMax

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

The maximum Z value in the area of the envelope.

Returns:

The zMax

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZMax

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

The maximum Z value in the area of the envelope.

Parameters:

zMax - The zMax (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

union

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

Adjusts to overlap inEnvelope.

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

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

Adjusts to include only the area also included by inEnvelope.

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

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

Moves the sides x units horizontally and y units vertically.

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

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

Moves the sides z units.

Parameters:

z - The z (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

offsetM

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

Moves the sides m units.

Parameters:

m - The m (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

expand

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.

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

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

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

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

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

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

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.

defineFromPoints

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

Defines the envelope to cover all the points.

Parameters:

count - The count (in)

points - 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.

putCoords

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.

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

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.

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

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

Moves this envelope so it is centered at p.

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.