com.esri.arcgis.geometry
Class IEnvelopeProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geometry.IGeometryProxy
          com.esri.arcgis.geometry.IEnvelopeProxy

All Implemented Interfaces:

java.io.Externalizable, IEnvelope, IGeometry, java.io.Serializable

Direct Known Subclasses:

IEnvelope2Proxy

public class IEnvelopeProxy

extends IGeometryProxy

implements IEnvelope, java.io.Serializable

Provides access to methods and properties of envelopes.

Product Availability

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

See Also:

Serialized Form

Field Summary

static java.lang.Class

targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF

Constructor Summary

	IEnvelopeProxy() For internal use only
	IEnvelopeProxy(java.lang.Object obj)
protected	IEnvelopeProxy(java.lang.Object obj, java.lang.String iid)
	IEnvelopeProxy(java.lang.String CLSID, java.lang.String host, AuthInfo authInfo)
protected	IEnvelopeProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, AuthInfo authInfo)

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Adds a Java object to be a listener for a specific kind of event generated by the COM object.
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	removeListener(java.lang.String iidStr, java.lang.Object theListener) Removes a Java object as a listener to events generated by a COM object.
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 class com.esri.arcgis.geometry.IGeometryProxy

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

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, hashCode, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, readExternal, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Field Detail

targetClass

public static final java.lang.Class targetClass

Constructor Detail

IEnvelopeProxy

public IEnvelopeProxy(java.lang.String CLSID,
                      java.lang.String host,
                      AuthInfo authInfo)
               throws java.net.UnknownHostException,
                      java.io.IOException

IEnvelopeProxy

public IEnvelopeProxy()

For internal use only

IEnvelopeProxy

public IEnvelopeProxy(java.lang.Object obj)
               throws java.io.IOException

IEnvelopeProxy

protected IEnvelopeProxy(java.lang.Object obj,
                         java.lang.String iid)
                  throws java.io.IOException

IEnvelopeProxy

protected IEnvelopeProxy(java.lang.String CLSID,
                         java.lang.String iid,
                         java.lang.String host,
                         AuthInfo authInfo)
                  throws java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Description copied from class: Dispatch

Adds a Java object to be a listener for a specific kind of event generated by the COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

addListener in class IGeometryProxy

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Description copied from class: Dispatch

Removes a Java object as a listener to events generated by a COM object. when you wish to invoke method on the COM object using IDispatch (not using custom marshalling).

Overrides:

removeListener in class IGeometryProxy

Throws:

java.io.IOException

getWidth

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

Description copied from interface: IEnvelope

The width of the envelope.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

getWidth in interface IEnvelope

Returns:

The width

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setWidth

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

Description copied from interface: IEnvelope

The width of the envelope.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setWidth in interface 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

Description copied from interface: IEnvelope

The height of the envelope.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

getHeight in interface IEnvelope

Returns:

The height

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setDepth

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

Description copied from interface: IEnvelope

The depth of the envelope.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDepth in interface 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

Description copied from interface: IEnvelope

The depth of the envelope.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

getDepth in interface 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

Description copied from interface: IEnvelope

The height of the envelope.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setHeight in interface IEnvelope

Parameters:

height - The height (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getLowerLeft

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

Description copied from interface: IEnvelope

The lower left corner.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns or sets the LowerLeft point of an Envelope .

Specified by:

getLowerLeft in interface 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

Description copied from interface: IEnvelope

The lower left corner.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLowerLeft in interface IEnvelope

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getUpperLeft

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

Description copied from interface: IEnvelope

The upper left corner.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns or sets the UpperLeft point of an Envelope .

Specified by:

getUpperLeft in interface 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

Description copied from interface: IEnvelope

The upper left corner.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUpperLeft in interface IEnvelope

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getUpperRight

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

Description copied from interface: IEnvelope

The upper right corner.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns or sets the UpperRight point of an Envelope .

Specified by:

getUpperRight in interface 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

Description copied from interface: IEnvelope

The upper right corner.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setUpperRight in interface IEnvelope

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getLowerRight

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

Description copied from interface: IEnvelope

The lower right corner.

Supported Platforms

Windows, Solaris, Linux

Remarks

Returns or sets the LowerRight point of an Envelope .

Specified by:

getLowerRight in interface 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

Description copied from interface: IEnvelope

The lower right corner.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setLowerRight in interface IEnvelope

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getXMin

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

Description copied from interface: IEnvelope

The position of the left side.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getXMin in interface 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

Description copied from interface: IEnvelope

The position of the left side.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXMin in interface 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

Description copied from interface: IEnvelope

The position of the bottom.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getYMin in interface 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

Description copied from interface: IEnvelope

The position of the bottom.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setYMin in interface IEnvelope

Parameters:

yMin - The yMin (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getXMax

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

Description copied from interface: IEnvelope

The position of the right side.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getXMax in interface 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

Description copied from interface: IEnvelope

The position of the right side.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setXMax in interface 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

Description copied from interface: IEnvelope

The position of the top.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

getYMax in interface IEnvelope

Returns:

The yMax

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setYMax

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

Description copied from interface: IEnvelope

The position of the top.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setYMax in interface IEnvelope

Parameters:

yMax - The yMax (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getMMin

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

Description copied from interface: IEnvelope

The minimum measure value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getMMin in interface IEnvelope

Returns:

The mMin

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMMin

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

Description copied from interface: IEnvelope

The minimum measure value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMMin in interface 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

Description copied from interface: IEnvelope

The maximum measure value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

getMMax in interface IEnvelope

Returns:

The mMax

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setMMax

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

Description copied from interface: IEnvelope

The maximum measure value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMMax in interface 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

Description copied from interface: IEnvelope

The minimum Z value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Description

ZMin defines the lower elevation boundary of the envelope.

Remarks

Specified by:

getZMin in interface 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

Description copied from interface: IEnvelope

The minimum Z value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZMin in interface IEnvelope

Parameters:

zMin - The zMin (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

getZMax

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

Description copied from interface: IEnvelope

The maximum Z value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Description

ZMax defines the upper elevation boundary of the envelope.

Remarks

Specified by:

getZMax in interface IEnvelope

Returns:

The zMax

Throws:

AutomationException - If the ArcObject component throws an exception.

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

setZMax

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

Description copied from interface: IEnvelope

The maximum Z value in the area of the envelope.

Supported Platforms

Windows, Solaris, Linux

Specified by:

setZMax in interface IEnvelope

Parameters:

zMax - The zMax (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

union

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

Description copied from interface: IEnvelope

Adjusts to overlap inEnvelope.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

union in interface IEnvelope

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

intersect

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

Description copied from interface: IEnvelope

Adjusts to include only the area also included by inEnvelope.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

intersect in interface IEnvelope

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

offset

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

Description copied from interface: IEnvelope

Moves the sides x units horizontally and y units vertically.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

offset in interface 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

Description copied from interface: IEnvelope

Moves the sides z units.

Supported Platforms

Windows, Solaris, Linux

Description

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

Remarks

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

Specified by:

offsetZ in interface 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

Description copied from interface: IEnvelope

Moves the sides m units.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

offsetM in interface 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

Description copied from interface: IEnvelope

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

Supported Platforms

Windows, Solaris, Linux

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.

XMin = (XMin - dx*Width)/2
YMin = (YMin - dy*Height)/2 
XMax = (XMax + dx*Width)/2
YMax = (YMax + dy*Height)/2

The Envelope remains centered at the same position.

Remarks

Specified by:

expand in interface IEnvelope

Parameters:

dx - The dx (in)

dy - The dy (in)

asRatio - The asRatio (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

expandZ

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

Description copied from interface: IEnvelope

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

Supported Platforms

Windows, Solaris, Linux

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)

Specified by:

expandZ in interface 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

Description copied from interface: IEnvelope

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

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

expandM in interface IEnvelope

Parameters:

dm - The dm (in)

asRatio - The asRatio (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

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

defineFromPoints

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

Description copied from interface: IEnvelope

Defines the envelope to cover all the points.

Supported Platforms

Windows, Solaris, Linux

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.

Specified by:

defineFromPoints in interface IEnvelope

Parameters:

count - The count (in)

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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

putCoords

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

Description copied from interface: IEnvelope

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

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

putCoords in interface 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

Description copied from interface: IEnvelope

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

Supported Platforms

Windows, Solaris, Linux

Description

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

Specified by:

queryCoords in interface 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:

AutomationException - If the ArcObject component throws an exception.

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

centerAt

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

Description copied from interface: IEnvelope

Moves this envelope so it is centered at p.

Supported Platforms

Windows, Solaris, Linux

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

Specified by:

centerAt in interface IEnvelope

Parameters:

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

Throws:

AutomationException - If the ArcObject component throws an exception.

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