|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
IEnvelopeGEN
. You can use the GEN interface proxy's Object-constructor to cast an instance of this interface to its GEN equivalent. Any ArcGIS class that implements this interface also implements the GEN interface.
public interface IEnvelope
Provides access to methods and properties of envelopes.
Envelopes are the rectangular window that contain a specific element. All Geometry objects have an envelope defined by the XMin, XMax, YMin, and YMax of the object. Envelopes can also serve as the viewing area for a particular view screen or data frame.
IPoint
,
IGeometry
Method Summary | |
---|---|
void |
centerAt(IPoint p)
Deprecated. Moves this envelope so it is centered at p. |
void |
defineFromPoints(int count,
IPoint points)
Deprecated. Defines the envelope to cover all the points. |
void |
expand(double dx,
double dy,
boolean asRatio)
Deprecated. Moves the X and Y coordinates of the sides toward or away from each other. |
void |
expandM(double dm,
boolean asRatio)
Deprecated. Moves the measure of the sides toward or away from each other. |
void |
expandZ(double dz,
boolean asRatio)
Deprecated. Moves the Z attribute of the sides toward or away from each other. |
double |
getDepth()
Deprecated. The depth of the envelope. |
double |
getHeight()
Deprecated. The height of the envelope. |
IPoint |
getLowerLeft()
Deprecated. The lower left corner. |
IPoint |
getLowerRight()
Deprecated. The lower right corner. |
double |
getMMax()
Deprecated. The maximum measure value in the area of the envelope. |
double |
getMMin()
Deprecated. The minimum measure value in the area of the envelope. |
IPoint |
getUpperLeft()
Deprecated. The upper left corner. |
IPoint |
getUpperRight()
Deprecated. The upper right corner. |
double |
getWidth()
Deprecated. The width of the envelope. |
double |
getXMax()
Deprecated. The position of the right side. |
double |
getXMin()
Deprecated. The position of the left side. |
double |
getYMax()
Deprecated. The position of the top. |
double |
getYMin()
Deprecated. The position of the bottom. |
double |
getZMax()
Deprecated. The maximum Z value in the area of the envelope. |
double |
getZMin()
Deprecated. The minimum Z value in the area of the envelope. |
void |
intersect(IEnvelope inEnvelope)
Deprecated. Adjusts to include only the area also included by inEnvelope. |
void |
offset(double x,
double y)
Deprecated. Moves the sides x units horizontally and y units vertically. |
void |
offsetM(double m)
Deprecated. Moves the sides m units. |
void |
offsetZ(double z)
Deprecated. Moves the sides z units. |
void |
putCoords(double xMin,
double yMin,
double xMax,
double yMax)
Deprecated. Constructs an envelope from the coordinate values of lower, left and upper, right corners. |
void |
queryCoords(double[] xMin,
double[] yMin,
double[] xMax,
double[] yMax)
Deprecated. Returns the coordinates of lower, left and upper, right corners. |
void |
setDepth(double depth)
Deprecated. The depth of the envelope. |
void |
setHeight(double height)
Deprecated. The height of the envelope. |
void |
setLowerLeft(IPoint lowerLeft)
Deprecated. The lower left corner. |
void |
setLowerRight(IPoint lowerRight)
Deprecated. The lower right corner. |
void |
setMMax(double mMax)
Deprecated. The maximum measure value in the area of the envelope. |
void |
setMMin(double mMin)
Deprecated. The minimum measure value in the area of the envelope. |
void |
setUpperLeft(IPoint upperLeft)
Deprecated. The upper left corner. |
void |
setUpperRight(IPoint upperRight)
Deprecated. The upper right corner. |
void |
setWidth(double width)
Deprecated. The width of the envelope. |
void |
setXMax(double xMax)
Deprecated. The position of the right side. |
void |
setXMin(double xMin)
Deprecated. The position of the left side. |
void |
setYMax(double yMax)
Deprecated. The position of the top. |
void |
setYMin(double yMin)
Deprecated. The position of the bottom. |
void |
setZMax(double zMax)
Deprecated. The maximum Z value in the area of the envelope. |
void |
setZMin(double zMin)
Deprecated. The minimum Z value in the area of the envelope. |
void |
union(IEnvelope inEnvelope)
Deprecated. Adjusts to overlap inEnvelope. |
Methods inherited from interface com.esri.arcgis.geometry.IGeometry |
---|
geoNormalize, geoNormalizeFromLongitude, getDimension, getEnvelope, getGeometryType, getSpatialReference, isEmpty, project, queryEnvelope, setEmpty, setSpatialReferenceByRef, snapToSpatialReference |
Method Detail |
---|
double getWidth() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getUpperLeft()
,
IEnvelope.getHeight()
,
IEnvelope.getLowerLeft()
,
IEnvelope.getLowerRight()
void setWidth(double width) throws IOException, AutomationException
width
- The width (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getHeight() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getWidth()
,
IEnvelope.getUpperLeft()
,
IEnvelope.getLowerLeft()
,
IEnvelope.getLowerRight()
,
IEnvelope.getUpperRight()
void setDepth(double depth) throws IOException, AutomationException
depth
- The depth (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getDepth() throws IOException, AutomationException
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.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setHeight(double height) throws IOException, AutomationException
height
- The height (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPoint getLowerLeft() throws IOException, AutomationException
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getWidth()
,
IEnvelope.getUpperLeft()
,
IEnvelope.getHeight()
,
IEnvelope.getLowerRight()
,
IEnvelope.getUpperRight()
void setLowerLeft(IPoint lowerLeft) throws IOException, AutomationException
lowerLeft
- A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPoint getUpperLeft() throws IOException, AutomationException
Returns or sets the UpperLeft point of an Envelope .
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getWidth()
,
IEnvelope.getHeight()
,
IEnvelope.getLowerLeft()
,
IEnvelope.getLowerRight()
,
IEnvelope.getUpperRight()
void setUpperLeft(IPoint upperLeft) throws IOException, AutomationException
upperLeft
- A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPoint getUpperRight() throws IOException, AutomationException
private void printEnvelope(IEnvelope envelope)
{
IPoint lowerLeft = envelope.LowerLeft;
IPoint lowerRight = envelope.LowerRight;
IPoint upperLeft = envelope.UpperLeft;
IPoint upperRight = envelope.UpperRight;
String report = "LowerLeft X = " + lowerLeft.X + "\n" +
"LowerLeft Y = " + lowerLeft.Y + "\n\n" +
"LowerRight X = " + lowerRight.X + "\n" +
"LowerRight Y = " + lowerRight.Y + "\n\n" +
"UpperLeft X = " + upperLeft.X + "\n" +
"UpperLeft Y = " + upperLeft.Y + "\n\n" +
"UpperRight X = " + upperRight.X + "\n" +
"UpperRight Y = " + upperRight.Y;
System.Windows.Forms.MessageBox.Show(report);
}
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getWidth()
,
IEnvelope.getUpperLeft()
,
IEnvelope.getHeight()
,
IEnvelope.getLowerLeft()
,
IEnvelope.getLowerRight()
void setUpperRight(IPoint upperRight) throws IOException, AutomationException
upperRight
- A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IPoint getLowerRight() throws IOException, AutomationException
private void printEnvelope(IEnvelope envelope)
{
IPoint lowerLeft = envelope.LowerLeft;
IPoint lowerRight = envelope.LowerRight;
IPoint upperLeft = envelope.UpperLeft;
IPoint upperRight = envelope.UpperRight;
String report = "LowerLeft X = " + lowerLeft.X + "\n" +
"LowerLeft Y = " + lowerLeft.Y + "\n\n" +
"LowerRight X = " + lowerRight.X + "\n" +
"LowerRight Y = " + lowerRight.Y + "\n\n" +
"UpperLeft X = " + upperLeft.X + "\n" +
"UpperLeft Y = " + upperLeft.Y + "\n\n" +
"UpperRight X = " + upperRight.X + "\n" +
"UpperRight Y = " + upperRight.Y;
System.Windows.Forms.MessageBox.Show(report);
}
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getWidth()
,
IEnvelope.getUpperLeft()
,
IEnvelope.getHeight()
,
IEnvelope.getLowerLeft()
,
IEnvelope.getUpperRight()
void setLowerRight(IPoint lowerRight) throws IOException, AutomationException
lowerRight
- A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getXMin() throws IOException, AutomationException
XMin is the left side coordinate of the envelope.
Setting Xmin to a value larger than Xmax will reverse Xmin and Xmax. Use PutCoords to avoid this behavior.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getYMin()
,
IEnvelope.getXMax()
void setXMin(double xMin) throws IOException, AutomationException
xMin
- The xMin (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getYMin() throws IOException, AutomationException
YMin is the bottom coordinate of the envelope.
Setting Ymin to a value larger than Ymax will reverse Ymin and Ymax. Use PutCoords to avoid this behavior.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getXMin()
,
IEnvelope.getXMax()
void setYMin(double yMin) throws IOException, AutomationException
yMin
- The yMin (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getXMax() throws IOException, AutomationException
XMax is the right side coordinate of the envelope.
Setting Xmax to a value smaller than Xmin will reverse Xmin and Xmax. Use PutCoords to avoid this behavior.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getYMin()
,
IEnvelope.getXMin()
void setXMax(double xMax) throws IOException, AutomationException
xMax
- The xMax (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getYMax() throws IOException, AutomationException
YMax is the top coordinate of the envelope.
Setting Ymax to a value smaller than Ymin will reverse Ymin and Ymax. Use PutCoords to avoid this behavior.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.getYMin()
,
IEnvelope.getXMin()
,
IEnvelope.getXMax()
void setYMax(double yMax) throws IOException, AutomationException
yMax
- The yMax (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getMMin() throws IOException, AutomationException
MMin is the minimum M value for the object owning the envelope.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setMMin(double mMin) throws IOException, AutomationException
double dMmin = null;
IEnvelope pEnv = null;
pEnv = new Envelope()
pEnv.setMMin(100.0);
dMmin = pEnv.getMMin();
mMin
- The mMin (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getMMax() throws IOException, AutomationException
MMax is the maximum M value for the object
owning the envelope.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setMMax(double mMax) throws IOException, AutomationException
mMax
- The mMax (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getZMin() throws IOException, AutomationException
ZMin defines the lower elevation boundary of the envelope.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setZMin(double zMin) throws IOException, AutomationException
zMin
- The zMin (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.double getZMax() throws IOException, AutomationException
ZMax defines the upper elevation boundary of the envelope.
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void setZMax(double zMax) throws IOException, AutomationException
double dZmax = null;
IEnvelope pEnv = null;
pEnv = new Envelope()
pEnv.setZMax(100.0);
dMmin = pEnv.getZMax();
zMax
- The zMax (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void union(IEnvelope inEnvelope) throws IOException, AutomationException
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.
inEnvelope
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.offset(double, double)
,
IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint)
,
IEnvelope.expand(double, double, boolean)
,
IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope)
void intersect(IEnvelope inEnvelope) throws IOException, AutomationException
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.).
inEnvelope
- A reference to a com.esri.arcgis.geometry.IEnvelope (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.offset(double, double)
,
IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint)
,
IEnvelope.expand(double, double, boolean)
,
IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)
void offset(double x, double y) throws IOException, AutomationException
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.
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
x
- The x (in)y
- The y (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint)
,
IEnvelope.expand(double, double, boolean)
,
IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope)
,
IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)
void offsetZ(double z) throws IOException, AutomationException
OffsetZ shifts the Z attributes of the Envelope. The Depth remains unchanged.
new ZMin = old ZMin + Z
new ZMax = old ZMax + Z
z
- The z (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void offsetM(double m) throws IOException, AutomationException
OffsetM shifts the M values for the Envelope. None of the other properties are changed.
new MMin = old MMin + M
new MMax = old MMax + M
m
- The m (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void expand(double dx, double dy, boolean asRatio) throws IOException, AutomationException
Expand scales the size of the Envelope. If asRatio = FALSE, the expansion is additive.
If asRatio = TRUE, the expansion is multiplicative. If the user wants to increase the envelope width by 10%, then dx = 1.1. On the other hand, if the user intends to decrease the width by 10%, then dx = 0.9. No negative number allowed when asRation is set to TRUE.XMin = XMin - dx
YMin = YMin - dy
XMax = XMax + dx
YMax = YMax + dy
XMin = XMin - (dx-1)*Width/2
YMin = YMin - (dy-1)*Height/2
XMax = XMax + (dx-1)*Width/2
YMax = YMax + (dy-1)*Height/2
The Envelope remains centered at the same position.
dx
- The dx (in)dy
- The dy (in)asRatio
- The asRatio (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.offset(double, double)
,
IEnvelope.centerAt(com.esri.arcgis.geometry.IPoint)
,
IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope)
,
IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)
void expandZ(double dz, boolean asRatio) throws IOException, AutomationException
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)
dz
- The dz (in)asRatio
- The asRatio (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void expandM(double dm, boolean asRatio) throws IOException, AutomationException
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).
dm
- The dm (in)asRatio
- The asRatio (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void defineFromPoints(int count, IPoint points) throws IOException, AutomationException
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.
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.
count
- The count (in)points
- A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.void putCoords(double xMin, double yMin, double xMax, double yMax) throws IOException, AutomationException
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.
xMin
- The xMin (in)yMin
- The yMin (in)xMax
- The xMax (in)yMax
- The yMax (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.queryCoords(double[], double[], double[], double[])
void queryCoords(double[] xMin, double[] yMin, double[] xMax, double[] yMax) throws IOException, AutomationException
Returns the XMin, YMin, XMax, and YMax values for the Envelope. These values can also be used to recreate the Envelope using PutCoords.
double dXmin[]= new double[1];
double dYmin[]= new double[1];
double dXmax[]= new double[1];
double dYmax[]= new double[1];
m_pEnveLope.queryCoords( dXmin, dYmin, dXmax, dYmax);
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)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.putCoords(double, double, double, double)
void centerAt(IPoint p) throws IOException, AutomationException
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).
The Center Point occurs at: ((XMin + XMax) / 2, (YMin + YMax) / 2).
p
- A reference to a com.esri.arcgis.geometry.IPoint (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.IEnvelope.offset(double, double)
,
IEnvelope.expand(double, double, boolean)
,
IEnvelope.intersect(com.esri.arcgis.geometry.IEnvelope)
,
IEnvelope.union(com.esri.arcgis.geometry.IEnvelope)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |