Envelope (ArcObjects Java API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geometry
Class Envelope

java.lang.Object
  com.esri.arcgis.geometry.Envelope

All Implemented Interfaces:: IArea, IClone, IEnvelope, IEnvelope2, IEnvelopeGEN, IGeometry, IGeometry2, IGeometry3, IGeometry4, IGeometry5, IHitTest, IMAware, IPersist, IPersistStream, IProximityOperator, IRelationalOperator, ISupportErrorInfo, ITransform2D, IXMLSerialize, IZAware, java.io.Serializable

public class Envelope
extends java.lang.Object
implements IEnvelopeGEN, IEnvelope, IEnvelope2, IMAware, IZAware, IGeometry, IGeometry2, IGeometry3, IGeometry4, IGeometry5, IArea, IProximityOperator, ITransform2D, IRelationalOperator, IHitTest, ISupportErrorInfo, IPersist, IPersistStream, IClone, IXMLSerialize

A rectangle with sides parallel to a coordinate system defining the extent of another geometry; optionally has min and max measure, height and ID attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Description

The Envelope coclass defines a rectangular shape by its minimum and maximum x,y coordinates. Therefore, an Envelope is always orthogonal to its SpatialReference. An Envelope may also define minimum and maximum z- and m-values, depending on the implemented IZAware and IMAware interfaces.

See Also:: Serialized Form

Constructor Summary
`Envelope()` Constructs a Envelope using ArcGIS Engine.
`Envelope(java.lang.Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary
`void`	`assign(IClone src)` Assigns the properties of src to the receiver.
`void`	`centerAt(IPoint p)` Moves this envelope so it is centered at p.
`boolean`	`contains(IGeometry other)` Indicates if this geometry contains the other geometry.
`boolean`	`crosses(IGeometry other)` Indicates if the two geometries intersect in a geometry of lesser dimension.
`void`	`defineFromPoints(int count, IPoint points)` Defines the envelope to cover all the points.
`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`	`deserialize(IXMLSerializeData data)` Deserializes an object from XML.
`boolean`	`disjoint(IGeometry other)` Indicates if the two geometries share no points in common.
`void`	`dropMs()` Sets all the M values to a non-valid number (NaN).
`void`	`dropZs()` Sets all the Z values to a non-valid number (NaN).
`boolean`	`equals(java.lang.Object o)` Compare this object with another
`IClone`	`esri_clone()` Clones the receiver and assigns the result to *clone.
`boolean`	`esri_equals(IGeometry other)` Indicates if the two geometries are of the same type and define the same set of points in the plane.
`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.
`void`	`geoNormalize()` Shifts longitudes, if need be, into a continuous range of 360 degrees.
`void`	`geoNormalizeFromLongitude(double longitude)` Normalizes longitudes into a continuous range containing the longitude.
`double`	`getArea()` The area.
`IArea`	`getAsIArea()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IClone`	`getAsIClone()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IEnvelope`	`getAsIEnvelope()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IEnvelope2`	`getAsIEnvelope2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IEnvelopeGEN`	`getAsIEnvelopeGEN()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeometry`	`getAsIGeometry()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeometry2`	`getAsIGeometry2()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeometry3`	`getAsIGeometry3()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeometry4`	`getAsIGeometry4()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IGeometry5`	`getAsIGeometry5()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IHitTest`	`getAsIHitTest()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IMAware`	`getAsIMAware()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPersist`	`getAsIPersist()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPersistStream`	`getAsIPersistStream()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IProximityOperator`	`getAsIProximityOperator()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IRelationalOperator`	`getAsIRelationalOperator()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ISupportErrorInfo`	`getAsISupportErrorInfo()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`ITransform2D`	`getAsITransform2D()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IXMLSerialize`	`getAsIXMLSerialize()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IZAware`	`getAsIZAware()` Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
`IPoint`	`getCentroid()` The center of gravity (centroid).
`IPoint`	`getCentroidEx()` The center of gravity (centroid).
`void`	`getClassID(GUID[] pClassID)` Supported Platforms
`static java.lang.String`	`getClsid()`
`double`	`getDepth()` The depth of the envelope.
`int`	`getDimension()` The topological dimension of this geometry.
`IEnvelope`	`getEnvelope()` Creates a copy of this geometry's envelope and returns it.
`int`	`getGeometryType()` The type of this geometry.
`double`	`getHeight()` The height of the envelope.
`IPoint`	`getLabelPoint()` A point guaranteed to be inside this area.
`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.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` Supported Platforms
`ISpatialReference`	`getSpatialReference()` The spatial reference associated with this geometry.
`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.
`int`	`hashCode()` the hashcode for this object
`boolean`	`hitTest(IPoint queryPoint, double searchRadius, int geometryPart, IPoint hitPoint, double[] hitDistance, int[] hitPartIndex, int[] hitSegmentIndex, boolean[] bRightSide)` Locates a part of a geometry closest to a query point.
`void`	`interfaceSupportsErrorInfo(GUID riid)` Supported Platforms
`void`	`intersect(IEnvelope inEnvelope)` Adjusts to include only the area also included by inEnvelope.
`boolean`	`isChanged()` Indicates if a geometry has been changed (edited, projected, etc).
`void`	`isDirty()` Supported Platforms
`boolean`	`isEmpty()` Indicates whether this geometry contains any points.
`boolean`	`isEqual(IClone other)` Returns TRUE when the receiver and other have the same properties.
`boolean`	`isIdentical(IClone other)` Returns TRUE when the receiver and other are the same object.
`boolean`	`isMAware()` Indicates whether or not the geometry is aware of and capable of handling Ms.
`boolean`	`isMSimple()` Indicates if all the Ms are valid numbers.
`boolean`	`isZAware()` Indicates whether or not the geometry is aware of and capable of handling Zs.
`boolean`	`isZSimple()` Indicates if all the Zs are valid numbers.
`void`	`load(IStream pstm)` Supported Platforms
`void`	`move(double dx, double dy)` Moves dx units horizontally and dy units vertically.
`void`	`moveVector(ILine v)` Moves a direction and distance v.
`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.
`boolean`	`overlaps(IGeometry other)` Indicates if the intersection of the two geometries has the same dimension as one of the input geometries.
`void`	`project(ISpatialReference newReferenceSystem)` Projects this geometry into a new spatial reference.
`void`	`project5(ISpatialReference newSpatialReference, int projectionHint)` Same as Project, but with additional parameter projectionHint.
`void`	`projectEx(ISpatialReference newReferenceSystem, int direction, IGeoTransformation geoTransformation, boolean bAngularDensify, double maxSegmentLength, double maxDeviation)` Projects a geometry, optionally applies a GeoTransformation, and optionally densifies the geometry.
`void`	`projectEx5(ISpatialReference newReferenceSystem, int direction, ITransformation transformation, boolean bAngularDensify, double maxSegmentLength, double maxDeviation, int projectionHint)` Same as ProjectEx, but with additional parameter projectionHint.
`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`	`putMCoords(double mMin, double mMax)` Sets the minimum and maximum M values simultaneously.
`void`	`putZCoords(double zMin, double zMax)` Sets the minimum and maximum Z values simultaneously.
`void`	`queryCentroid(IPoint center)` Copies the centroid of this area to the specified point.
`void`	`queryCoords(double[] xMin, double[] yMin, double[] xMax, double[] yMax)` Returns the coordinates of lower, left and upper, right corners.
`void`	`queryEnvelope(IEnvelope outEnvelope)` Copies this geometry's envelope properties into the specified envelope.
`void`	`queryLabelPoint(IPoint labelPoint)` Copies to the input point a point guaranteed to be inside this area.
`void`	`queryMCoords(double[] mMin, double[] mMax)` Queries the minimum and maximum M values simultaneously.
`void`	`queryNearestPoint(IPoint p, int extension, IPoint nearest)` Copies into 'nearest' a point on this geometry nearest to the input point.
`void`	`queryWKSEnvelope(_WKSEnvelope e)` Defines the specified wksenvelope to be the current extent of this geometry in the x-y plane.
`void`	`queryZCoords(double[] zMin, double[] zMax)` Queries the minimum and maximum Z values simultaneously.
`boolean`	`relation(IGeometry other, java.lang.String relationDescription)` Indicates if the defined relationship exists.
`double`	`returnDistance(IGeometry other)` Returns the minimum distance between two geometries.
`IPoint`	`returnNearestPoint(IPoint p, int extension)` Creates and returns a point on this geometry nearest to the input point.
`void`	`rotate(IPoint origin, double rotationAngle)` Rotates about the specified origin point.
`void`	`save(IStream pstm, int fClearDirty)` Supported Platforms
`void`	`scale(IPoint origin, double sx, double sy)` Scales about the specified origin using seperate horizonal and vertical scales.
`void`	`serialize(IXMLSerializeData data)` Serializes an object to XML.
`void`	`setChanged(boolean isChanged)` Indicates if a geometry has been changed (edited, projected, etc).
`void`	`setDepth(double depth)` The depth of the envelope.
`void`	`setEmpty()` Removes all points from this geometry.
`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`	`setMAware(boolean mAware)` Indicates whether or not the geometry is aware of and capable of handling Ms.
`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`	`setSpatialReferenceByRef(ISpatialReference spatialRef)` The spatial reference associated with this geometry.
`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`	`setZAware(boolean zAware)` Indicates whether or not the geometry is aware of and capable of handling Zs.
`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`	`snapToSpatialReference()` Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.
`boolean`	`touches(IGeometry other)` Indicates if the boundaries of the geometries intersect.
`void`	`transform(int direction, ITransformation transformation)` Applies an arbitrary transformation.
`void`	`union(IEnvelope inEnvelope)` Adjusts to overlap inEnvelope.
`boolean`	`within(IGeometry other)` Indicates if this geometry is contained (is within) another geometry.

Methods inherited from class java.lang.Object

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

Constructor Detail

Envelope

public Envelope()
         throws java.io.IOException,
                java.net.UnknownHostException

Constructs a Envelope using ArcGIS Engine.
Throws:: java.io.IOException - if there are interop problems; java.net.UnknownHostException - if there are interop problems

Envelope

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.; Construct a Envelope using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Envelope.
Envelope theEnvelope = (Envelope) obj;
Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIEnvelopeGEN

public IEnvelopeGEN getAsIEnvelopeGEN()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIEnvelope

public IEnvelope getAsIEnvelope()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIEnvelope2

public IEnvelope2 getAsIEnvelope2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIMAware

public IMAware getAsIMAware()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIZAware

public IZAware getAsIZAware()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeometry

public IGeometry getAsIGeometry()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeometry2

public IGeometry2 getAsIGeometry2()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeometry3

public IGeometry3 getAsIGeometry3()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeometry4

public IGeometry4 getAsIGeometry4()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIGeometry5

public IGeometry5 getAsIGeometry5()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIArea

public IArea getAsIArea()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIProximityOperator

public IProximityOperator getAsIProximityOperator()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsITransform2D

public ITransform2D getAsITransform2D()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIRelationalOperator

public IRelationalOperator getAsIRelationalOperator()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIHitTest

public IHitTest getAsIHitTest()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsISupportErrorInfo

public ISupportErrorInfo getAsISupportErrorInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersist

public IPersist getAsIPersist()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIPersistStream

public IPersistStream getAsIPersistStream()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIClone

public IClone getAsIClone()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

getAsIXMLSerialize

public IXMLSerialize getAsIXMLSerialize()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

defineFromWKSPoints

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

Description copied from interface: IEnvelopeGEN

Defines the envelope to cover all the points.

Description

Please see the DefineFromWKSPoints method of IEnvelope for more details

Specified by:: defineFromWKSPoints in interface IEnvelopeGEN

Parameters:: wksPoints - A Structure: com.esri.arcgis.system._WKSPoint (An array of com.esri.arcgis.system._WKSPoint COM typedef) (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

defineFromPoints

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

Description copied from interface: IEnvelopeGEN

Defines the envelope to cover all the points.

Description

Please see the DefineFromPoints method of IEnvelope for more details

Specified by:: defineFromPoints in interface IEnvelopeGEN

Parameters:: points - A reference to a com.esri.arcgis.geometry.IPoint array (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getWidth

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

Description copied from interface: IEnvelopeGEN

The width of the envelope.

Description

refer to the Width property of IEnvelope

Specified by:: getWidth in interface IEnvelopeGEN

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: IEnvelopeGEN

The width of the envelope.

Description

refer to the Width property of IEnvelope

Specified by:: setWidth in interface IEnvelopeGEN

Parameters:: width - The width (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getHeight

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

Description copied from interface: IEnvelopeGEN

The height of the envelope.

Description

refer to the Height property of IEnvelope

Specified by:: getHeight in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

The depth of the envelope.

Description

refer to the Depth property of IEnvelope

Specified by:: setDepth in interface IEnvelopeGEN

Parameters:: depth - The depth (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getDepth

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

Description copied from interface: IEnvelopeGEN

The depth of the envelope.

Description

refer to the Depth property of IEnvelope

Specified by:: getDepth in interface IEnvelopeGEN

Returns:: The depth
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setHeight

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

Description copied from interface: IEnvelopeGEN

The height of the envelope.

Description

refer to the Height property of IEnvelope

Specified by:: setHeight in interface IEnvelopeGEN

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: IEnvelopeGEN

The lower left corner.

Description

refer to the LowerLeft property of IEnvelope

Specified by:: getLowerLeft in interface IEnvelopeGEN

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setLowerLeft

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

Description copied from interface: IEnvelopeGEN

The lower left corner.

Description

refer to the LowerLeft property of IEnvelope

Specified by:: setLowerLeft in interface IEnvelopeGEN

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: IEnvelopeGEN

The upper left corner.

Description

refer to the UpperLeft property of IEnvelope

Specified by:: getUpperLeft in interface IEnvelopeGEN

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setUpperLeft

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

Description copied from interface: IEnvelopeGEN

The upper left corner.

Description

refer to the UpperLeft property of IEnvelope

Specified by:: setUpperLeft in interface IEnvelopeGEN

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: IEnvelopeGEN

The upper right corner.

Description

refer to the UpperRight property of IEnvelope

Specified by:: getUpperRight in interface IEnvelopeGEN

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setUpperRight

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

Description copied from interface: IEnvelopeGEN

The upper right corner.

Description

refer to the UpperRight property of IEnvelope

Specified by:: setUpperRight in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

The lower right corner.

Description

refer to the LowerRight property of IEnvelope

Specified by:: getLowerRight in interface IEnvelopeGEN

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setLowerRight

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

Description copied from interface: IEnvelopeGEN

The lower right corner.

Description

refer to the LowerRight property of IEnvelope

Specified by:: setLowerRight in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

The position of the left side.

Description

refer to the XMin property of IEnvelope

Specified by:: getXMin in interface IEnvelopeGEN

Returns:: The xMin
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setXMin

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

Description copied from interface: IEnvelopeGEN

The position of the left side.

Description

refer to the XMin property of IEnvelope

Specified by:: setXMin in interface IEnvelopeGEN

Parameters:: xMin - The xMin (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getYMin

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

Description copied from interface: IEnvelopeGEN

The position of the bottom.

Description

refer to the YMin property of IEnvelope

Specified by:: getYMin in interface IEnvelopeGEN

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: IEnvelopeGEN

The position of the bottom.

Description

refer to the YMin property of IEnvelope

Specified by:: setYMin in interface IEnvelopeGEN

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: IEnvelopeGEN

The position of the right side.

Description

refer to the XMax property of IEnvelope

Specified by:: getXMax in interface IEnvelopeGEN

Returns:: The xMax
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setXMax

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

Description copied from interface: IEnvelopeGEN

The position of the right side.

Description

refer to the XMax property of IEnvelope

Specified by:: setXMax in interface IEnvelopeGEN

Parameters:: xMax - The xMax (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getYMax

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

Description copied from interface: IEnvelopeGEN

The position of the top.

Description

refer to the YMax property of IEnvelope

Specified by:: getYMax in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

The position of the top.

Description

refer to the YMax property of IEnvelope

Specified by:: setYMax in interface IEnvelopeGEN

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: IEnvelopeGEN

The minimum measure value in the area of the envelope.

Description

refer to the MMin property of IEnvelope

Specified by:: getMMin in interface IEnvelopeGEN

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: IEnvelopeGEN

The minimum measure value in the area of the envelope.

Description

refer to the MMin property of IEnvelope

Specified by:: setMMin in interface IEnvelopeGEN

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: IEnvelopeGEN

The maximum measure value in the area of the envelope.

Description

refer to the MMax property of IEnvelope

Specified by:: getMMax in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

The maximum measure value in the area of the envelope.

Description

refer to the MMax property of IEnvelope

Specified by:: setMMax in interface IEnvelopeGEN

Parameters:: mMax - The mMax (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getZMin

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

Description copied from interface: IEnvelopeGEN

The minimum Z value in the area of the envelope.

Description

refer to the ZMin property of IEnvelope

Specified by:: getZMin in interface IEnvelopeGEN

Returns:: The zMin
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setZMin

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

Description copied from interface: IEnvelopeGEN

The minimum Z value in the area of the envelope.

Description

refer to the ZMin property of IEnvelope

Specified by:: setZMin in interface IEnvelopeGEN

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: IEnvelopeGEN

The maximum Z value in the area of the envelope.

Description

refer to the ZMax property of IEnvelope

Specified by:: getZMax in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

The maximum Z value in the area of the envelope.

Description

refer to the ZMax property of IEnvelope

Specified by:: setZMax in interface IEnvelopeGEN

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: IEnvelopeGEN

Adjusts to overlap inEnvelope.

Description

refer to the Union method of IEnvelope

Specified by:: union in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

Adjusts to include only the area also included by inEnvelope.

Description

refer to the Intersect method of IEnvelope

Specified by:: intersect in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

Moves the sides x units horizontally and y units vertically.

Description

refer to the Offset method of IEnvelope

Specified by:: offset in interface IEnvelopeGEN

Parameters:: x - The x (in); y - The y (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

offsetZ

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

Description copied from interface: IEnvelopeGEN

Moves the sides z units.

Description

refer to the OffsetZ method of IEnvelope

Specified by:: offsetZ in interface IEnvelopeGEN

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: IEnvelopeGEN

Moves the sides m units.

Description

refer to the OffsetM method of IEnvelope

Specified by:: offsetM in interface IEnvelopeGEN

Parameters:: m - The m (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

expand

public void expand(double dx,
                   double dy,
                   boolean asRatio)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IEnvelopeGEN

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

Description

refer to the Expand method of IEnvelope

Specified by:: expand in interface IEnvelopeGEN

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: IEnvelopeGEN

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

Description

refer to the ExpandZ method of IEnvelope

Specified by:: expandZ in interface IEnvelopeGEN

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: IEnvelopeGEN

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

Description

refer to the ExpandM method of IEnvelope

Specified by:: expandM in interface IEnvelopeGEN

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.

putCoords

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

Description copied from interface: IEnvelopeGEN

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

Description

refer to the PutCoords method of IEnvelope

Specified by:: putCoords in interface IEnvelopeGEN

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: IEnvelopeGEN

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

Description

refer to the QueryCoords method of IEnvelope

Specified by:: queryCoords in interface IEnvelopeGEN

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

Description copied from interface: IEnvelopeGEN

Moves this envelope so it is centered at p.

Description

refer to the CenterAt method of IEnvelope

Specified by:: centerAt in interface IEnvelopeGEN

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.

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.

getGeometryType

public int getGeometryType()
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IGeometry

The type of this geometry.

Supported Platforms

Windows, Solaris, Linux

Remarks

esriGeometryNull          = 0
esriGeometryPoint         = 1
esriGeometryMultipoint    = 2
esriGeometryPolyline      = 3
esriGeometryPolygon       = 4
esriGeometryEnvelope      = 5
esriGeometryPath          = 6
esriGeometryAny           = 7
esriGeometryMultiPatch    = 9
esriGeometryRing          = 11
esriGeometryLine          = 13
esriGeometryCircularArc   = 14
esriGeometryBezier3Curve  = 15
esriGeometryEllipticArc   = 16
esriGeometryBag           = 17
esriGeometryTriangleStrip = 18
esriGeometryTriangleFan   = 19
esriGeometryRay           = 20
esriGeometrySphere        = 21

Specified by:: getGeometryType in interface IGeometry

Returns:: A com.esri.arcgis.geometry.esriGeometryType constant
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDimension

public int getDimension()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IGeometry

The topological dimension of this geometry.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the dimension of the geometry object based on the geometry's type.

Remarks

Note: At 9.0, Multipatches are now considered as two dimensional geometry. esriGeometry3Dimension will be used for an upcoming new geometry type.

Supported esriGeometryDimensions:

-1    esriGeometryNoDimension
1    esriGeometry0Dimension
2    esriGeometry1Dimension
4    esriGeometry2Dimension
5    esriGeometry25Dimension
6    esriGeometry3Dimension

Dimension Example

Specified by:: getDimension in interface IGeometry

Returns:: A com.esri.arcgis.geometry.esriGeometryDimension constant
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws java.io.IOException,
                                             AutomationException

Description copied from interface: IGeometry

The spatial reference associated with this geometry.

Supported Platforms

Windows, Solaris, Linux

Description

Returns and sets the Spatial Reference in which the geometry exists. If the spatial reference has not been set the property will return an empty ISpatialReference instance.

Specified by:: getSpatialReference in interface IGeometry

Returns:: A reference to a com.esri.arcgis.geometry.ISpatialReference
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws java.io.IOException,
                                     AutomationException

Description copied from interface: IGeometry

The spatial reference associated with this geometry.

Specified by:: setSpatialReferenceByRef in interface IGeometry

Parameters:: spatialRef - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isEmpty

public boolean isEmpty()
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGeometry

Indicates whether this geometry contains any points.

Specified by:: isEmpty in interface IGeometry

Returns:: The isEmpty
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setEmpty

public void setEmpty()
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IGeometry

Removes all points from this geometry.

Specified by:: setEmpty in interface IGeometry

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryEnvelope

public void queryEnvelope(IEnvelope outEnvelope)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IGeometry

Copies this geometry's envelope properties into the specified envelope.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the unique Envelope that binds the Geometry object. This is the smallest Envelope that Contains the object.

Remarks

Note: The output geometry must be co-created prior to the query. The output geometry is not co-created by the method; it is populated. This can be used in performance critical situations. For example, creating the geometry only once outside a loop and use the query method could improve performance.

QueryEnvelope Example

Specified by:: queryEnvelope in interface IGeometry

Parameters:: outEnvelope - 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.

getEnvelope

public IEnvelope getEnvelope()
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGeometry

Creates a copy of this geometry's envelope and returns it.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the unique Envelope that binds the Geometry object. This is the smallest Envelope that Contains the object.

Remarks

Envelope Example

Specified by:: getEnvelope in interface IGeometry

Returns:: A reference to a com.esri.arcgis.geometry.IEnvelope
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

project

public void project(ISpatialReference newReferenceSystem)
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IGeometry

Projects this geometry into a new spatial reference.

Supported Platforms

Windows, Solaris, Linux

Description

To Project, the geometry needs to have a Spatial Reference set, and not have an UnknownCoordinateSystem. The new spatial reference system passed to the method defines the output coordinate system. If either spatial reference is Unknown, the coordinates are not changed. The Z and measure values are not changed by the Project method.

A geometry is not densified before it is projected. This can lead to the output geometries not reflecting the 'true' shape in the new coordinate system. A straight line in one coordinate system is not necessarily a straight line in a different coordinate system. Use IGeometry2::ProjectEx if you want to densify the geometries while they are projected.

Remarks

Note: If the from/to spatial references have different geographic coordinate systems, the Project method looks for a GeoTransformationsOperationSet. If the set of Geotransformations is present in memory, Project will use it to perform a geographic/datum Transformation. To use a specific geotransformation, use the IGeometry2::ProjectEx method.

Specified by:: project in interface IGeometry

Parameters:: newReferenceSystem - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

snapToSpatialReference

public void snapToSpatialReference()
                            throws java.io.IOException,
                                   AutomationException

Description copied from interface: IGeometry

Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.

Supported Platforms

Windows, Solaris, Linux

Remarks

SnapToSpatialReference rounds all coordinates to the resolution defined by the geometry's spatial reference system. This has a smilar effect on the geometry as storing the geometry in a Geodatabase (*.mdb or ArcSDE).

Specified by:: snapToSpatialReference in interface IGeometry

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

geoNormalize

public void geoNormalize()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGeometry

Shifts longitudes, if need be, into a continuous range of 360 degrees.

Supported Platforms

Windows, Solaris, Linux

Remarks

GeoNormalize acts on geometries whose geographic system coordinates are below -180 degrees longitude or over +180 degrees longitude or on geometries that span the +-180 degrees longitude.

This method requires the geometry to have a valid spatial reference (geographic or projected coordinate system).

This method is used internally as part of the projection process for polygons and polylines. It is typically not used by itself.

Specified by:: geoNormalize in interface IGeometry

Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

geoNormalizeFromLongitude

public void geoNormalizeFromLongitude(double longitude)
                               throws java.io.IOException,
                                      AutomationException

Description copied from interface: IGeometry

Normalizes longitudes into a continuous range containing the longitude. This method is obsolete.

Supported Platforms

Windows, Solaris, Linux

Remarks

This method is obsolete. Use IGeometry::GeoNormalize instead.

This method requires the geometry to have a valid spatial reference (geographic or projected coordinate system).

Specified by:: geoNormalizeFromLongitude in interface IGeometry

Parameters:: longitude - The longitude (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

putZCoords

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

Description copied from interface: IEnvelope2

Sets the minimum and maximum Z values simultaneously.

Supported Platforms

Windows, Solaris, Linux

Description

Sets the ZMin and ZMax simultaneously. This avoids complications of setting ZMin and ZMax individually in which they could become inconsistent.

Specified by:: putZCoords in interface IEnvelope2

Parameters:: zMin - The zMin (in); zMax - The zMax (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryZCoords

public void queryZCoords(double[] zMin,
                         double[] zMax)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IEnvelope2

Queries the minimum and maximum Z values simultaneously.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the values of ZMin and ZMax respectively.

Specified by:: queryZCoords in interface IEnvelope2

Parameters:: zMin - The zMin (out: use single element array); zMax - The zMax (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

putMCoords

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

Description copied from interface: IEnvelope2

Sets the minimum and maximum M values simultaneously.

Supported Platforms

Windows, Solaris, Linux

Description

Sets the MMin and MMax simultaneously. This avoids complications of setting MMin and MMax individually in which they could become inconsistent.

Specified by:: putMCoords in interface IEnvelope2

Parameters:: mMin - The mMin (in); mMax - The mMax (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

queryMCoords

public void queryMCoords(double[] mMin,
                         double[] mMax)
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IEnvelope2

Queries the minimum and maximum M values simultaneously.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the values of MMin and MMax respectively.

Specified by:: queryMCoords in interface IEnvelope2

Parameters:: mMin - The mMin (out: use single element array); mMax - The mMax (out: use single element array)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isMAware

public boolean isMAware()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IMAware

Indicates whether or not the geometry is aware of and capable of handling Ms.

Supported Platforms

Windows, Solaris, Linux

Description

Returns or sets the M Awareness state of the geometry object. If MAware is TRUE, then the object will recognize that it has M attributes and perform operations on them as necessary. If MAware is FALSE, the object will ignore Ms while performing operations.

Specified by:: isMAware in interface IMAware

Returns:: The mAware
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setMAware

public void setMAware(boolean mAware)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IMAware

Indicates whether or not the geometry is aware of and capable of handling Ms.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMAware in interface IMAware

Parameters:: mAware - The mAware (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isMSimple

public boolean isMSimple()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IMAware

Indicates if all the Ms are valid numbers.

Supported Platforms

Windows, Solaris, Linux

Description

MSimple is TRUE if none of the M values held by the geometry object are NaN. If any of the Ms within the object are NaN, MSimple is FALSE.

Specified by:: isMSimple in interface IMAware

Returns:: The mSimple
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

dropMs

public void dropMs()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IMAware

Sets all the M values to a non-valid number (NaN).

Supported Platforms

Windows, Solaris, Linux

Description

Resets all of the current M values held by the geometry object back to NaN. MAware does not change.

Specified by:: dropMs in interface IMAware

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isZAware

public boolean isZAware()
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IZAware

Indicates whether or not the geometry is aware of and capable of handling Zs.

Supported Platforms

Windows, Solaris, Linux

Description

Returns or sets the Z Awareness state of the geometry object. If ZAware is TRUE, then the object will recognize that it has Z attributes and perform operations on them as necessary. If ZAware is FALSE, the object will ignore Zs while performing operations. ZAware should only be set to TRUE when all of the Zs are not NaN.

Remarks

Use ZAware = True when you want geometries to retain Z values during geometry operations.

Specified by:: isZAware in interface IZAware

Returns:: The zAware
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setZAware

public void setZAware(boolean zAware)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IZAware

Indicates whether or not the geometry is aware of and capable of handling Zs.

Supported Platforms

Windows, Solaris, Linux

Specified by:: setZAware in interface IZAware

Parameters:: zAware - The zAware (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isZSimple

public boolean isZSimple()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IZAware

Indicates if all the Zs are valid numbers.

Supported Platforms

Windows, Solaris, Linux

Description

ZSimple is TRUE if none of the Z values held by the geometry object are NaN. If any of the Zs within the object are NaN, ZSimple is FALSE.

Specified by:: isZSimple in interface IZAware

Returns:: The zSimple
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

dropZs

public void dropZs()
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IZAware

Sets all the Z values to a non-valid number (NaN).

Supported Platforms

Windows, Solaris, Linux

Description

Resets all of the current Z values held by the geometry object back to NaN. ZAware does not change.

Specified by:: dropZs in interface IZAware

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

projectEx

public void projectEx(ISpatialReference newReferenceSystem,
                      int direction,
                      IGeoTransformation geoTransformation,
                      boolean bAngularDensify,
                      double maxSegmentLength,
                      double maxDeviation)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IGeometry2

Projects a geometry, optionally applies a GeoTransformation, and optionally densifies the geometry.

Supported Platforms

Windows, Solaris, Linux

Remarks

By default, ProjectEx will not densify geometries as they are projected. This can lead to the output geometries not reflecting the 'true' shape in the new coordinate system. A straight line in one coordinate system is not necessarily a straight line in a different coordinate system. Set the bAngularDensify parameter if you want to densify the geometries while they are projected.

Specified by:: projectEx in interface IGeometry2

Parameters:: newReferenceSystem - A reference to a com.esri.arcgis.geometry.ISpatialReference (in); direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); geoTransformation - A reference to a com.esri.arcgis.geometry.IGeoTransformation (in); bAngularDensify - The bAngularDensify (in); maxSegmentLength - The maxSegmentLength (in); maxDeviation - The maxDeviation (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

queryWKSEnvelope

public void queryWKSEnvelope(_WKSEnvelope e)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IGeometry3

Defines the specified wksenvelope to be the current extent of this geometry in the x-y plane.

Supported Platforms

Windows, Solaris, Linux

Description

The QueryWKSEnvelope method returns a WKSEnvelope structure corresponding to the envelope of the geometry. Use that method to quickly get the XMin, XMax, YMin and YMax values.

Specified by:: queryWKSEnvelope in interface IGeometry3

Parameters:: e - A Structure: com.esri.arcgis.system._WKSEnvelope (A com.esri.arcgis.system._WKSEnvelope COM typedef) (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isChanged

public boolean isChanged()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IGeometry4

Indicates if a geometry has been changed (edited, projected, etc).

Supported Platforms

Windows, Solaris, Linux

Description

The Changed method returns whether or not the geometry has been modified. If the geometry always stays in memory that method only returns 'false' immediately after its creation. However if the shape came from disk the Changed method will return 'false' until de geometry is modified in memory.

Specified by:: isChanged in interface IGeometry4

Returns:: The isChanged
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setChanged

public void setChanged(boolean isChanged)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGeometry4

Indicates if a geometry has been changed (edited, projected, etc).

Supported Platforms

Windows, Solaris, Linux

Specified by:: setChanged in interface IGeometry4

Parameters:: isChanged - The isChanged (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

project5

public void project5(ISpatialReference newSpatialReference,
                     int projectionHint)
              throws java.io.IOException,
                     AutomationException

Description copied from interface: IGeometry5

Same as Project, but with additional parameter projectionHint.

Description

The projectionHint parameter contains information about whether a geometry will cross the coordinate system horizons. If it doesn't, parts of the code that check this and intersect the geometry with the horizons can be omitted. This can dramatically improve performance. Use ISpatialReference3::ProjectionHint to initialize this parameter.

Specified by:: project5 in interface IGeometry5

Parameters:: newSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in); projectionHint - The projectionHint (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

projectEx5

public void projectEx5(ISpatialReference newReferenceSystem,
                       int direction,
                       ITransformation transformation,
                       boolean bAngularDensify,
                       double maxSegmentLength,
                       double maxDeviation,
                       int projectionHint)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IGeometry5

Same as ProjectEx, but with additional parameter projectionHint.

Description

Remarks

Specified by:: projectEx5 in interface IGeometry5

Parameters:: newReferenceSystem - A reference to a com.esri.arcgis.geometry.ISpatialReference (in); direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in); bAngularDensify - The bAngularDensify (in); maxSegmentLength - The maxSegmentLength (in); maxDeviation - The maxDeviation (in); projectionHint - The projectionHint (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCentroidEx

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

Description copied from interface: IGeometry5

The center of gravity (centroid).

Specified by:: getCentroidEx in interface IGeometry5

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getArea

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

Description copied from interface: IArea

The area.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the area enclosed between the Exterior Rings and the Interior Rings of the 2 (or 2.5) Dimensional geometry. Interior Rings return a negative Area.

Remarks

Area Example

Specified by:: getArea in interface IArea

Returns:: The area
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getCentroid

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

Description copied from interface: IArea

The center of gravity (centroid).

Supported Platforms

Windows, Solaris, Linux

Description

Returns the Centroid of the 2 (or 2.5) Dimensional figure. The Centroid is the center of the weighted area.

Remarks

The Centroid does not always occur inside the Area of the geometry. The Centroid is not the same as the center of the geometry or the Envelope binding the geometry (but it may be if and only if that is also the center of the weighted area).

Centroid Example

Specified by:: getCentroid in interface IArea

Returns:: A reference to a com.esri.arcgis.geometry.IPoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getLabelPoint

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

Description copied from interface: IArea

A point guaranteed to be inside this area.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the Label Point of the object. The Label Point is the point at which the label is located. The Label Point is always located within the Area of the object.

Specified by:: getLabelPoint in interface IArea

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.

queryCentroid

public void queryCentroid(IPoint center)
                   throws java.io.IOException,
                          AutomationException

Description copied from interface: IArea

Copies the centroid of this area to the specified point.

Supported Platforms

Windows, Solaris, Linux

Description

Queries the Centroid of the 2 (or 2.5) Dimensional figure. The Centroid is the center of the weighted area. You must instantiate the Point before calling QueryCentroid. For example,

Dim pPoint as IPoint
Set pPoint = New Point

Remarks

Centroid Example

Specified by:: queryCentroid in interface IArea

Parameters:: center - 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.

queryLabelPoint

public void queryLabelPoint(IPoint labelPoint)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IArea

Copies to the input point a point guaranteed to be inside this area.

Supported Platforms

Windows, Solaris, Linux

Description

Queries the Label Point of the object. The Label Point is the point at which the label is located. The Label Point is always located within the Area of the object. You must instantiate the point before calling QueryLabelPoint. For example,

Dim pPoint as IPoint
Set pPoint = New Point

Remarks

Specified by:: queryLabelPoint in interface IArea

Parameters:: labelPoint - 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.

queryNearestPoint

public void queryNearestPoint(IPoint p,
                              int extension,
                              IPoint nearest)
                       throws java.io.IOException,
                              AutomationException

Description copied from interface: IProximityOperator

Copies into 'nearest' a point on this geometry nearest to the input point.

Supported Platforms

Windows, Solaris, Linux

Description

Queries the nearest point on a geometry to the input point. Depending on the method of segment extension, the nearest point can also be found on an extension of the geometry.

Remarks

QueryNearestPoint Example

Specified by:: queryNearestPoint in interface IProximityOperator

Parameters:: p - A reference to a com.esri.arcgis.geometry.IPoint (in); extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); nearest - 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.
See Also:: esriSegmentExtension

returnNearestPoint

public IPoint returnNearestPoint(IPoint p,
                                 int extension)
                          throws java.io.IOException,
                                 AutomationException

Description copied from interface: IProximityOperator

Creates and returns a point on this geometry nearest to the input point.

Supported Platforms

Windows, Solaris, Linux

Description

Finds and returns the nearest point on a geometry to the input point. Depending on the method of segment extension, the nearest point can also be found on an extension of the geometry.

Remarks

ReturnNearestPoint Example

Specified by:: returnNearestPoint in interface IProximityOperator

Parameters:: p - A reference to a com.esri.arcgis.geometry.IPoint (in); extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in)
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.
See Also:: esriSegmentExtension

returnDistance

public double returnDistance(IGeometry other)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IProximityOperator

Returns the minimum distance between two geometries.

Supported Platforms

Windows, Solaris, Linux

Description

Returns the minimum distance between two geometries. If the geometries intersect, the minimum distance is 0. Only returns the distance, and not the nearest points.

Remarks

ReturnDistance Example

The geometry combinations which can be used with ReturnDistance are:

Point: Point, MultiPoint, Envelope, Polyline, Polygon, Line, CircularArc, EllipticArc, BezierCurve.
Multipoint: Point, MultiPoint, Envelope, Polyline, Polygon.
Envelope: Point, MultiPoint, Envelope, Line, CircularArc, EllipticArc, BezierCurve, PolyLine, Polygon.
PolyLine: Point, Multipoint, Envelope, PolyLine, Polygon.
Polygon: Point, Multipoint, Envelope, PolyLine, Polygon.
Line: Point, Envelope, Line, CircularArc, EllipticArc, BezierCurve.
CircularArc: Point, Envelope, Line, CircularArc, EllipticArc (not implemented yet), BezierCurve.
EllipticArc: Point, Envelope, Line, CircularArc (not implemented yet), EllipticArc (not implemented yet), BezierCurve (not implemented yet).
BezierCurve: Point, Envelope, Line, CircularArc, EllipticArc (not implemented yet), BezierCurve.

Note: To get the distance between a segment (Line, CircularArc, EllipticArc, BezierCurve) and a MultiPoint, PolyLine or Polygon, add that segment to a PolyLine.

Specified by:: returnDistance in interface IProximityOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The distance
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

move

public void move(double dx,
                 double dy)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: ITransform2D

Moves dx units horizontally and dy units vertically.

Supported Platforms

Windows, Solaris, Linux

Description

Moves the Geometry dX units along the X-Axis and dY units along the Y-Axis. Only changes the position of the Geometry without altering any of the other characteristics. Move is a spatial offset.

Remarks

Transform2D Move Example

Specified by:: move in interface ITransform2D

Parameters:: dx - The dx (in); dy - The dy (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

moveVector

public void moveVector(ILine v)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: ITransform2D

Moves a direction and distance v. v can be in a different spatial reference than the geometry being moved.

Supported Platforms

Windows, Solaris, Linux

Description

Moves the Geometry dX units along the X-Axis and dY units along the Y-Axis, where dX and dY are calculated from the input vector Line. Only the Length and Angle of the vector affect the transformation. The location of the vector does not change the transformation. Only changes the position of the Geometry without altering any of the other characteristics. Move is a spatial offset.

Remarks

Transform2D MoveVector Example

Specified by:: moveVector in interface ITransform2D

Parameters:: v - A reference to a com.esri.arcgis.geometry.ILine (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

scale

public void scale(IPoint origin,
                  double sx,
                  double sy)
           throws java.io.IOException,
                  AutomationException

Description copied from interface: ITransform2D

Scales about the specified origin using seperate horizonal and vertical scales. The origin point can be in a different spatial reference than the geometry being scaled.

Supported Platforms

Windows, Solaris, Linux

Description

Stretches the Geometry a factor of sX along the X-Axis and a factor of sY along the Y-Axis (where sX is the ratio of Old Width to New Width, and sY is the ratio of Old Height to New Height). The Origin point is the reference Point from which the transformation is performed (Regardless of the location of the Origin point, the Geometry resulting from the transformation is the same, except for a positional offset). The Origin is the only point in the transformation guaranted to remain in the same location after the transformation is complete.

Remarks

Note: Caution must be taken when scaling a CircularArc or a geometry containing CircularArc segments. Unless Abs(ScaleX) = Abs(ScaleY), the resulting CircularArcs will not retain the characteristics of the original geometry (since they remain CircularArcs).

Scale Example

Specified by:: scale in interface ITransform2D

Parameters:: origin - A reference to a com.esri.arcgis.geometry.IPoint (in); sx - The sx (in); sy - The sy (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

rotate

public void rotate(IPoint origin,
                   double rotationAngle)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: ITransform2D

Rotates about the specified origin point. The angle is in radians. The origin can be in a different spatial reference than the geometry being rotated.

Supported Platforms

Windows, Solaris, Linux

Description

Rotate performs an angular transform (rotation) on the Geometry. The Origin is the only point in the transformation guaranteed to remain in the same location after the transformation is performed. Regardless of the Origin, the transformed Geometry is the same, except for a positional offset. The RotationAngle is measured in radians.

Remarks

An Envelope cannot be Rotated.

Transform2D Rotate Example

Specified by:: rotate in interface ITransform2D

Parameters:: origin - A reference to a com.esri.arcgis.geometry.IPoint (in); rotationAngle - The rotationAngle (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

transform

public void transform(int direction,
                      ITransformation transformation)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: ITransform2D

Applies an arbitrary transformation. In particular, the transformation parameter can be either an affine transformation or a geographic transformation (datum shift).

Supported Platforms

Windows, Solaris, Linux

Specified by:: transform in interface ITransform2D

Parameters:: direction - A com.esri.arcgis.geometry.esriTransformDirection constant (in); transformation - A reference to a com.esri.arcgis.geometry.ITransformation (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

esri_equals

public boolean esri_equals(IGeometry other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IRelationalOperator

Indicates if the two geometries are of the same type and define the same set of points in the plane.

Specified by:: esri_equals in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The esri_equals
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

touches

public boolean touches(IGeometry other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IRelationalOperator

Indicates if the boundaries of the geometries intersect.

Supported Platforms

Windows, Solaris, Linux

Description

Two geometries are said to touch when the intersection of the geometries is non-empty, but the intersection of their interiors is empty. Touches is a Clementini operator. For example, a point touches a polyline only if the point is coincident with one of the polyline end points.

Touches examples. Only "true" relationships are showed in this picture.

Remarks

Only geometries that support the IRelationalOperator interface can be used as input geometries.

Touch does not apply for point/point comparison.

Specified by:: touches in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The touches
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

contains

public boolean contains(IGeometry other)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IRelationalOperator

Indicates if this geometry contains the other geometry.

Supported Platforms

Windows, Solaris, Linux

Description

The base geometry contains the comparison geometry (other) if the comparison geometry is a subset of the base geometry and the intersection of their interiors is not empty. Therefore a polygon does not contain any part of its 1D boundary. Contains is the opposite operator of Within.

Remarks

Only geometries that support the IRelationalOperator interface can be used as input geometries.

If geometry1 Contains geometry2, then geometry2 is Within geometry1.

Contains examples. Only "true" relationships are showed in this picture.

Specified by:: contains in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The contains
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

within

public boolean within(IGeometry other)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IRelationalOperator

Indicates if this geometry is contained (is within) another geometry.

Supported Platforms

Windows, Solaris, Linux

Description

The base geometry is within the comparison geometry if the base geometry is the intersection of the geometries and the intersection of their interiors is not empty. Within is a Clementini operator. Within is the opposite operator of contains.

Remarks

Only geometries that support the IRelationalOperator interface can be used as input geometries.

If geometry1 is Within geometry2, then geometry2 Contains geometry1.

Within examples. Only "true" relationships are showed in this picture.

Specified by:: within in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The within
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

disjoint

public boolean disjoint(IGeometry other)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IRelationalOperator

Indicates if the two geometries share no points in common. Negate this result to compute the Intersect relation.

Supported Platforms

Windows, Solaris, Linux

Description

Two geometries are disjoint if their intersection is empty. Two geometries intersect if disjoint is "false". Disjoint is a Clementini operator.

Remarks

Only geometries that support the IRelationalOperator interface can be used as input geometries.

Disjoint example. Only "true" relationships are showed in this picture.

Specified by:: disjoint in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The disjoint
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

crosses

public boolean crosses(IGeometry other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IRelationalOperator

Indicates if the two geometries intersect in a geometry of lesser dimension.

Supported Platforms

Windows, Solaris, Linux

Description

Two polylines cross if they share only points in common, at least one of which is not an endpoint. A polyline and an polygon cross if they share a polyline in common on the interior of the polygon which is not equivalent to the entire polyline. Cross is a Clementini operator.

Remarks

Only geometries that support the IRelationalOperator interface can be used as input geometries.

Cross only applies to polyline/polyline, polyline/polygon, or polygon/polyline relations.

Crosses examples. Only "true" relationships are showed in this picture.

Specified by:: crosses in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The crosses
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

overlaps

public boolean overlaps(IGeometry other)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IRelationalOperator

Indicates if the intersection of the two geometries has the same dimension as one of the input geometries.

Supported Platforms

Windows, Solaris, Linux

Description

Two geometries overlap if the region of their intersection is of the same dimension as the geometries involved and is not equivalent to either of the geometries. Overlaps is a Clementini operator.

Remarks

Only geometries that support the IRelationalOperator interface can be used as input geometries.

Overlaps only applies to polyline/polyline, polygon/polygon and multipoint/multipoint relations.

Overlaps examples. Only "true" relationships are showed in this picture.

Specified by:: overlaps in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Returns:: The overlaps
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

relation

public boolean relation(IGeometry other,
                        java.lang.String relationDescription)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IRelationalOperator

Indicates if the defined relationship exists.

Supported Platforms

Windows, Solaris, Linux

Description

Relation allows a general relation defined using the Shape Comparison Language to be determined between two input geometries. The Shape Comparison Language is based on the Calculus-Based Method (CBM), as described and defined by Clementini and Felice, but has some extensions specific to working with vertex-based geometries and is fully described in the Technical Documents section of the ArcObjects Developer Help. Please refer to the Shape Comparison Language documentation for proper syntax and available functionality.

Note that at the current release, Relation only operates with straight lines.

Specified by:: relation in interface IRelationalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in); relationDescription - The relationDescription (in)
Returns:: The relationResult
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hitTest

public boolean hitTest(IPoint queryPoint,
                       double searchRadius,
                       int geometryPart,
                       IPoint hitPoint,
                       double[] hitDistance,
                       int[] hitPartIndex,
                       int[] hitSegmentIndex,
                       boolean[] bRightSide)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IHitTest

Locates a part of a geometry closest to a query point. Any located part must be within searchRadius units from the query point.

Supported Platforms

Windows, Solaris, Linux

Remarks

The segment index returned has different meanings depending on the esriGeometryHitPartType used (Please see the example for more details).

EsriGeometryPartVertex: returns a vertex index

EsriGeometryPartBoundary, esriGeometryPartMidpoint and esriGeometryPartEndpoint: return a segment index

EsriGeometryPartCentroid: Always returns 0 for the part index and the segment index.

brightside: Indicates if the input point is on the right side of the input geometry

Note: The distance units use in this method are the units of the input geometry. No conversion is performed. esriGeometryHitPartType parameter cannot be a combination of several esriGeometryHitPartTypes.

Specified by:: hitTest in interface IHitTest

Parameters:: queryPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); searchRadius - The searchRadius (in); geometryPart - A com.esri.arcgis.geometry.esriGeometryHitPartType constant (in); hitPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); hitDistance - The hitDistance (in/out: use single element array); hitPartIndex - The hitPartIndex (in/out: use single element array); hitSegmentIndex - The hitSegmentIndex (in/out: use single element array); bRightSide - The bRightSide (in/out: use single element array)
Returns:: The bHit
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: ISupportErrorInfo

Supported Platforms

Windows, Solaris, Linux

Description

Indicates whether the interface supports IErrorInfo.

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:: riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersist

Supported Platforms

Windows, Solaris, Linux

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: getClassID in interface IPersist

Parameters:: pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: isDirty in interface IPersistStream

Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: load in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: save in interface IPersistStream

Parameters:: pstm - A reference to a com.esri.arcgis.system.IStream (in); fClearDirty - The fClearDirty (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IPersistStream

Supported Platforms

Windows, Solaris, Linux

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Specified by:: getSizeMax in interface IPersistStream

Parameters:: pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Description copied from interface: IClone

Clones the receiver and assigns the result to *clone.

Specified by:: esri_clone in interface IClone

Returns:: A reference to a com.esri.arcgis.system.IClone
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Description copied from interface: IClone

Assigns the properties of src to the receiver.

Supported Platforms

Windows, Solaris, Linux

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Specified by:: assign in interface IClone

Parameters:: src - A reference to a com.esri.arcgis.system.IClone (in)
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other have the same properties.

Specified by:: isEqual in interface IClone

Parameters:: other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:: The equal
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IClone

Returns TRUE when the receiver and other are the same object.

Specified by:: isIdentical in interface IClone

Parameters:: other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:: The identical
Throws:: AutomationException - If the ArcObject component throws an exception.; java.io.IOException - If there are interop problems.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Description copied from interface: IXMLSerialize

Serializes an object to XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:: serialize in interface IXMLSerialize

Parameters:: data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Description copied from interface: IXMLSerialize

Deserializes an object from XML.

Supported Platforms

Windows, Solaris, Linux

Specified by:: deserialize in interface IXMLSerialize

Parameters:: data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:: java.io.IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geometry Class Envelope

Product Availability

Supported Platforms

Description

Envelope

Envelope

getClsid

getAsIEnvelopeGEN

getAsIEnvelope

getAsIEnvelope2

getAsIMAware

getAsIZAware

getAsIGeometry

getAsIGeometry2

getAsIGeometry3

getAsIGeometry4

getAsIGeometry5

getAsIArea

getAsIProximityOperator

getAsITransform2D

getAsIRelationalOperator

getAsIHitTest

getAsISupportErrorInfo

getAsIPersist

getAsIPersistStream

getAsIClone

getAsIXMLSerialize

equals

hashCode

defineFromWKSPoints

Description

defineFromPoints

Description

getWidth

Description

setWidth

Description

getHeight

Description

setDepth

Description

getDepth

Description

setHeight

Description

getLowerLeft

Description

setLowerLeft

Description

getUpperLeft

Description

setUpperLeft

Description

getUpperRight

Description

setUpperRight

Description

getLowerRight

Description

setLowerRight

Description

getXMin

Description

setXMin

Description

getYMin

Description

setYMin

Description

getXMax

Description

setXMax

Description

getYMax

Description

setYMax

Description

getMMin

Description

setMMin

com.esri.arcgis.geometry
Class Envelope