Point (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 Point

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

All Implemented Interfaces:: IConstructPoint, IConstructPoint2, IConversionMGRS, IConversionNotation, IGeometry, IGeometry2, IGeometry3, IGeometry4, IGeometry5, IHitTest, IHitTest3D, IMAware, IMSnap, IPoint, IPointIDAware, IProximityOperator, IProximityOperator3D, IRelationalOperator, IRelationalOperator2, IRelationalOperator3D, IRelationalOperator3D2, ITopologicalOperator, ITopologicalOperator6, ITransform2D, ITransform3D, IZAware, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, Externalizable, Serializable

public class Point
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPoint, IMAware, IZAware, IPointIDAware, IGeometry, IGeometry2, IGeometry3, IGeometry4, IGeometry5, ITransform2D, ITransform3D, IConstructPoint, IConstructPoint2, IRelationalOperator, IRelationalOperator2, IProximityOperator, ITopologicalOperator, ITopologicalOperator6, IHitTest, IHitTest3D, ISupportErrorInfo, IPersist, IPersistStream, IClone, IXMLSerialize, IConversionMGRS, IConversionNotation, IMSnap, IProximityOperator3D, IRelationalOperator3D, IRelationalOperator3D2, Externalizable
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPoint, IMAware, IZAware, IPointIDAware, IGeometry, IGeometry2, IGeometry3, IGeometry4, IGeometry5, ITransform2D, ITransform3D, IConstructPoint, IConstructPoint2, IRelationalOperator, IRelationalOperator2, IProximityOperator, ITopologicalOperator, ITopologicalOperator6, IHitTest, IHitTest3D, ISupportErrorInfo, IPersist, IPersistStream, IClone, IXMLSerialize, IConversionMGRS, IConversionNotation, IMSnap, IProximityOperator3D, IRelationalOperator3D, IRelationalOperator3D2, Externalizable

A two dimensional point, optionally with measure, height, and ID attributes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

Constructor Summary
`Point()` Constructs a Point using ArcGIS Engine.
`Point(Object obj)` Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. `Point thePoint = (Point) obj;`

Method Summary
`void`	`assign(IClone src)` Assigns the properties of src to the receiver.
`IGeometry`	`buffer(double distance)` Constructs a polygon that is the locus of points at a distance less than or equal to a specified distance from this geometry.
`void`	`clip(IEnvelope clipperEnvelope)` Constructs the intersection of this geometry and the specified envelope.
`void`	`clipDense(IEnvelope clipperEnvelope, double denseDistance)` Constructs the intersection of this geometry and the specified envelope; densifies lines in output contributed by the clipping envelope.
`int`	`compare(IPoint otherPoint)` Compares X, Y, M, Z, ID of this point (in that order) with that of the other point.
`void`	`constrainAngle(double constraintAngle, IPoint anchor, boolean allowOpposite)` Projects this point to the point on the infinite line defined by anchor and angle (in radians).
`void`	`constrainDistance(double constraintRadius, IPoint anchor)` Projects this point to the perimeter of the circle defined by radius and anchor.
`void`	`constructAlong(ICurve curve, int extension, double distance, boolean asRatio)` Constructs a point distance units along the input curve.
`void`	`constructAngleBisector(IPoint from, IPoint through, IPoint to, double distance, boolean useAcuteAngle)` Constructs a point on the bisector of the angle (from, through, to).
`void`	`constructAngleDistance(IPoint p, double inAngle, double distance)` Constructs a point at a specified angle (in radians) from the horizontal axis and a specified distance away from the input point.
`void`	`constructAngleIntersection(IPoint p1, double angle1, IPoint p2, double angle2)` Constructs the point of intersection between two lines defined by the input points and angles (in radians).
`void`	`constructAverage(IPointCollection points, int attributeType)` Constructs the geometric average of the input point collection.
`void`	`constructDeflection(ILine baseLine, double distance, double inAngle)` Constructs a point in the polar coordinate system defined by baseLine and its 'from' point.
`void`	`constructDeflectionIntersection(ILine baseLine, double startAngle, double endAngle, boolean onRightSide)` Constructs the point of intersection of two rays with origins at the endpoints of the base line and the specified angles (in radians).
`void`	`constructOffset(ICurve curve, int extension, double distance, boolean asRatio, double offset)` Constructs a point distance units along the input curve and offset units perpendicularly away from it.
`void`	`constructParallel(ISegment segment, int extension, IPoint start, double distance)` Constructs a point distance units from start, parallel to the tangent at the point nearest to start on the (extended) segment.
`void`	`constructPerpendicular(ISegment base, int extension, IPoint p, double distance, boolean bUseLineOrientation)` Constructs a point 'distance' units from p and lying along the line normal to base and passing through p.
`void`	`constructThreePointResection(IPoint point1, double angleP1P2, IPoint point2, double angleP2P3, IPoint point3, double[] arcAngle)` Constructs the point of observation from which two signed angles between three points were measured; returns an angle which can help establish the confidence of the observation location: A small angle indicates greater uncertainty in the location.
`void`	`constructUnion(IEnumGeometry geometries)` Defines this geometry to be the union of the inputs.
`void`	`constructUnionEx(IEnumGeometry pEnum, boolean bNonPlanar)` Defines this geometry to be the union of the inputs, with the option for non-planary result.
`boolean`	`contains(IGeometry other)` Indicates if this geometry contains the other geometry.
`boolean`	`containsEx(IGeometry pOther, int relation)` Indicates if this geometry contains the other geometry, optionally using Celementini's definition.
`IGeometry`	`convexHull()` Constructs the convex hull of this geometry.
`String`	`createMGRS(int numDigits, boolean round, int mode)` Returns the MGRS/USNG description of a point.
`boolean`	`crosses(IGeometry other)` Indicates if the two geometries intersect in a geometry of lesser dimension.
`void`	`cut(IPolyline cutter, IGeometry[] leftGeom, IGeometry[] rightGeom)` Splits this geometry into a part left of the cutting polyline, and a part right of it.
`void`	`deserialize(IXMLSerializeData data)` Deserializes an object from XML.
`IGeometry`	`difference(IGeometry other)` Constructs the geometry containing points from this geometry but not the other geometry.
`IGeometry`	`differenceEx(IGeometry other, boolean bNonPlanar)` defined for (multi)points and polylines.
`boolean`	`disjoint(IGeometry other)` Indicates if the two geometries share no points in common.
`boolean`	`disjoint3D(IGeometry pOther)` Indicates if the two geometries share no points in common.
`void`	`dropMs()` Sets all the M values to a non-valid number (NaN).
`void`	`dropPointIDs()` Unsets all PointID values without changing awareness.
`void`	`dropZs()` Sets all the Z values to a non-valid number (NaN).
`boolean`	`equals(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`	`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.
`IGeometry`	`getBoundary()` The boundary of this geometry.
`IPoint`	`getCentroidEx()` The center of gravity (centroid).
`void`	`getClassID(GUID[] pClassID)` getClassID
`static String`	`getClsid()` getClsid.
`String`	`getDDFromCoords(int precision)` Returns the decimal degrees description of a point.
`String`	`getDDMFromCoords(int precision)` Returns the degrees decimal minutes description of a point.
`int`	`getDimension()` The topological dimension of this geometry.
`String`	`getDMSFromCoords(int precision)` Returns the degrees/minutes/seconds description of a point.
`IEnvelope`	`getEnvelope()` Creates a copy of this geometry's envelope and returns it.
`String`	`getGARSFromCoords()` Returns the GARS description of a point.
`int`	`getGeometryType()` The type of this geometry.
`String`	`getGeoRefFromCoords(int numDigits, boolean numericRounding)` Returns the GeoRef description of a point.
`int`	`getID()` The Point ID attribute.
`double`	`getM()` The measure attribute.
`void`	`getSizeMax(_ULARGE_INTEGER[] pcbSize)` getSizeMax
`ISpatialReference`	`getSpatialReference()` The spatial reference associated with this geometry.
`String`	`getUSNGFromCoords(int numDigits, boolean numericRounding, boolean addSpaces)` Returns the USNG description of a point.
`String`	`getUTMFromCoords(int utmOptions)` Returns the UTM description of a point.
`double`	`getX()` The X coordinate.
`double`	`getY()` The Y coordinate.
`double`	`getZ()` The Z attribute.
`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.
`boolean`	`hitTest3D(IPoint queryPoint, double searchRadius, int geometryPart, IPoint hitPoint, double[] hitDistance, int[] hitPartIndex, int[] hitSegmentIndex)` Locates a part of a geometry closest to a query point.
`boolean`	`hitTestCone(IRay pQueryRay, double minAngle, int geometryPart, IPoint pHitPoint, double[] pHitDistance, int[] pHitPartIndex, int[] pHitSegmentIndex)` Locates a part of a geometry closest to a query ray.
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`IGeometry`	`intersect(IGeometry other, int resultDimension)` Constructs the geometry that is the set-theoretic intersection of the input geometries.
`IGeometry`	`intersectEx(IGeometry other, boolean bNonPlanar, int resultDimension)` Constructs the set-theoretic intersection of the inputs in the specified result dimension, , with the option for non-planary result.
`IGeometry`	`intersectMultidimensionEx(IGeometry other, boolean bNonPlanar)` Constructs the set-theoretic intersection of the inputs.
`boolean`	`isChanged()` Indicates if a geometry has been changed (edited, projected, etc).
`void`	`isDirty()` isDirty
`boolean`	`isEmpty()` Indicates whether this geometry contains any points.
`boolean`	`isEqual(IClone other)` Indicates if the receiver and other have the same properties.
`boolean`	`isIdentical(IClone other)` Indicates if the receiver and other are the same object.
`boolean`	`isKnownSimple()` Indicates whether this geometry is known (or assumed) to be topologically correct.
`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`	`isNear(IGeometry pOther, double distance)` Indicates if this geometry is within distance from the other geometry.
`boolean`	`isNear3D(IGeometry pOther, double distance)` Indicates if this geometry is within distance from the other geometry; both geometries must have Zs.
`boolean`	`isPointIDAware()` Indicates whether or not the geometry is aware of and capable of handling PointIDs.
`boolean`	`isPointIDSimple()` Indicates if all PointID values for this geometry are well-defined.
`boolean`	`isSimple()` Indicates whether this geometry is known (or assumed) to be topologically correct, after explicitly determining this if the geometry is not already known (or assumed) to be simple.
`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)` load
`void`	`move(double dx, double dy)` Moves dx units horizontally and dy units vertically.
`void`	`move3D(double dx, double dy, double dz)` Moves the object by dx, dy and dz along the x, y, and z axes respectively.
`void`	`moveVector(ILine v)` Moves a direction and distance v.
`void`	`moveVector3D(IVector3D v)` Moves the object by an offset defined by a 3D vector.
`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.
`IGeometry`	`projectToPlane(IPoint planarOrigin, IVector3D planarPositiveX, IVector3D planarNorm)` Generates a polygon footprint for the object in an arbitrary plane.
`void`	`putCoords(double x, double y)` Sets the X and Y coordinates.
`void`	`putCoordsFromDD(String dDString)` Creates the coordinates of a point from the decimal degrees description.
`void`	`putCoordsFromDDM(String dDMString)` Creates the coordinates of a point from the degrees decimal minutes description.
`void`	`putCoordsFromDMS(String dMSString)` Creates the coordinates of a point from the degrees/minutes/seconds description.
`void`	`putCoordsFromGARS(int mode, String gARSString)` Creates the coordinates of a point from the GARS description.
`void`	`putCoordsFromGeoRef(String geoRefString)` Creates the coordinates of a point from the GeoRef description.
`void`	`putCoordsFromMGRS(String mgrs, int mode)` Creates the coordinates of a point from the MGRS/USNG description.
`void`	`putCoordsFromUSNG(String uSNGString)` Creates the coordinates of a point from the USNG description.
`void`	`putCoordsFromUTM(int utmOptions, String uTMString)` Creates the coordinates of a point from the UTM description.
`void`	`queryClipped(IEnvelope clipperEnvelope, IGeometry clippedGeometry)` Redefines clippedGeometry to be the intersection of this geometry and the clipping envelope.
`void`	`queryClippedDense(IEnvelope clipperEnvelope, double denseDistance, IGeometry clippedGeometry)` Redefines clippedGeometry to be the intersection of this geometry and the clipping envelope; densifies lines in the output contributed by the clipping envelope.
`void`	`queryCoords(double[] x, double[] y)` Returns the X and Y coordinates.
`void`	`queryEnvelope(IEnvelope outEnvelope)` Copies this geometry's envelope properties into the specified envelope.
`void`	`queryNearestPoint(IPoint p, int extension, IPoint nearest)` Copies into 'nearest' a point on this geometry nearest to the input point.
`void`	`queryNearestPoint3D(IPoint pInP, int extension, IPoint pNearest)` 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`	`readExternal(ObjectInput in)`
`boolean`	`relation(IGeometry other, String relationDescription)` Indicates if the defined relationship exists.
`double`	`returnDistance(IGeometry other)` Returns the minimum distance between two geometries.
`double`	`returnDistance3D(IGeometry pOther)` Returns the minimal distance between two geometries.
`IPoint`	`returnNearestPoint(IPoint p, int extension)` Creates and returns a point on this geometry nearest to the input point.
`IPoint`	`returnNearestPoint3D(IPoint pInP, 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`	`rotateVector3D(IVector3D axis, double rotationAngle)` Rotates the object about axis defined by the specified vector through an angle measured in radians.
`void`	`save(IStream pstm, int fClearDirty)` save
`void`	`scale(IPoint origin, double sx, double sy)` Scales about the specified origin using seperate horizonal and vertical scales.
`void`	`scale3D(IPoint origin, double sx, double sy, double sz)` Scales the object about the specified origin point.
`void`	`serialize(IXMLSerializeData data)` Serializes an object to XML.
`void`	`setChanged(boolean isChanged)` Indicates if a geometry has been changed (edited, projected, etc).
`void`	`setEmpty()` Removes all points from this geometry.
`void`	`setID(int pointID)` The Point ID attribute.
`void`	`setM(double m)` The measure attribute.
`void`	`setMAware(boolean mAware)` Indicates whether or not the geometry is aware of and capable of handling Ms.
`void`	`setPointIDAware(boolean idAware)` Indicates whether or not the geometry is aware of and capable of handling PointIDs.
`void`	`setSpatialReferenceByRef(ISpatialReference spatialRef)` The spatial reference associated with this geometry.
`void`	`setX(double x)` The X coordinate.
`void`	`setY(double y)` The Y coordinate.
`void`	`setZ(double z)` The Z attribute.
`void`	`setZAware(boolean zAware)` Indicates whether or not the geometry is aware of and capable of handling Zs.
`void`	`simplify()` Makes this geometry topologically correct.
`void`	`simplifyAsFeature()` Simplifies the geometry using the rules appropriate for this feature.
`void`	`snap()` Snaps ms to the precision of the spatial reference associated with the geometry.
`void`	`snapToSpatialReference()` Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.
`IGeometry`	`symmetricDifference(IGeometry other)` Constructs the geometry that contains points from either but not both input geometries.
`IGeometry`	`symmetricDifferenceEx(IGeometry other, boolean bNonPlanar)` defined for (multi)points and polylines.
`boolean`	`touches(IGeometry other)` Indicates if the boundaries of the geometries intersect.
`void`	`transform(int direction, ITransformation transformation)` Applies an arbitrary transformation.
`void`	`transform3D(int direction, ITransformation3D transformation)` Applies an arbitrary 3D transformation.
`IGeometry`	`union(IGeometry other)` Constructs the geometry that is the set-theoretic union of the input geometries.
`IGeometry`	`unionEx(IGeometry other, boolean bNonPlanar)` Constructs the set-theoretic union of the inputs, with the option for non-planary result.
`boolean`	`within(IGeometry other)` Indicates if this geometry is contained (is within) another geometry.
`boolean`	`withinEx(IGeometry pOther, int relation)` Indicates if this geometry contains the other geometry, optionally using Celementini's definition.
`void`	`writeExternal(ObjectOutput out)`

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
`getJintegraDispatch, release`

Constructor Detail

Point

public Point()
      throws IOException,
             UnknownHostException

Constructs a Point using ArcGIS Engine.

Throws:: IOException - if there are interop problems; UnknownHostException - if there are interop problems

Point

public Point(Object obj)
      throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
Point thePoint = (Point) obj;

Construct a Point using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to Point.

Parameters:: obj - an object returned from ArcGIS Engine or Server
Throws:: IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:: equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:: hashCode in class Object

queryCoords

public void queryCoords(double[] x,
                        double[] y)
                 throws IOException,
                        AutomationException

Returns the X and Y coordinates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryCoords in interface IPoint

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

putCoords

public void putCoords(double x,
                      double y)
               throws IOException,
                      AutomationException

Sets the X and Y coordinates.

Remarks

Use the IPoint::PutCoords method to set the X,Y coordinates for a Point. The coordinates can also be set by updating the X and Y properties for the point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: putCoords in interface IPoint

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

getX

public double getX()
            throws IOException,
                   AutomationException

The X coordinate.

Description

Returns and Sets the X coordinate of the Point. The X coordinate is the horizontal position of the point.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getX in interface IPoint

Returns:: The x
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPoint.getZ(), IPoint.getM(), IPoint.getY()

setX

public void setX(double x)
          throws IOException,
                 AutomationException

The X coordinate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setX in interface IPoint

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

getY

public double getY()
            throws IOException,
                   AutomationException

The Y coordinate.

Description

Returns and Sets the Y coordinate of the Point. The Y coordinate is the vertical position of the point.

Remarks

Point Y Coord Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getY in interface IPoint

Returns:: The y
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPoint.getZ(), IPoint.getM(), IPoint.getX()

setY

public void setY(double y)
          throws IOException,
                 AutomationException

The Y coordinate.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setY in interface IPoint

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

getZ

public double getZ()
            throws IOException,
                   AutomationException

The Z attribute.

Description

Returns or Sets the Z attribute on the Point. Although the Z attribute refers to the 3-Dimensional depth of the point, the point still spatially exists in only 2-Dimensions with a Z attribute. Further, the point must be ZAware to make use of the Z attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getZ in interface IPoint

Returns:: The z
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPoint.getZ(), IZAware, IPoint.getM(), IZCollection, IZ, IPoint.getX(), IPoint.getY()

setZ

public void setZ(double z)
          throws IOException,
                 AutomationException

The Z attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setZ in interface IPoint

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

getM

public double getM()
            throws IOException,
                   AutomationException

The measure attribute.

Description

Returns or Sets the M attribute on the Point. The M attribute refers to the Point's measure (similar to an address). The point must be MAware to make use of the M attribute.

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getM in interface IPoint

Returns:: The m
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPoint.getZ(), IPoint.getM(), IMSegmentation, IMSegmentation2, IMCollection, IMAware, IPoint.getX(), IPoint.getY()

setM

public void setM(double m)
          throws IOException,
                 AutomationException

The measure attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setM in interface IPoint

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

getID

public int getID()
          throws IOException,
                 AutomationException

The Point ID attribute.

Description

Returns or Sets the ID attribute of the Point. The ID attribute is a numeric label, but does not serve any computational purposes. The Point must be PointIDAware to make use of the ID attribute.

Remarks

To set the ID value for a point you need to define it to be ID aware.

Example:

IPoint pPoint 
pPoint = new Point();
pPoint.putCoords( 100,  100);
IPointIDAware pIDA 
pIDA = new IPointIDAwareProxy(pPoint);
pIDA.pointIDAware(true);
pPoint.setID(10);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getID in interface IPoint

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

setID

public void setID(int pointID)
           throws IOException,
                  AutomationException

The Point ID attribute.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setID in interface IPoint

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

constrainDistance

public void constrainDistance(double constraintRadius,
                              IPoint anchor)
                       throws IOException,
                              AutomationException

Projects this point to the perimeter of the circle defined by radius and anchor.

Description

Sets the base Point to a location a specified distance from the input anchor Point along the line between the two points. ConstrainDistance is used by the editor to fix the distance between an anchor point and an input Point. Thus, the input to be created must lie on the circumference defined by the anchor point and the fixed distance radius with the angle determined by the user.

Remarks

ConstrainDistance

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constrainDistance in interface IPoint

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

constrainAngle

public void constrainAngle(double constraintAngle,
                           IPoint anchor,
                           boolean allowOpposite)
                    throws IOException,
                           AutomationException

Projects this point to the point on the infinite line defined by anchor and angle (in radians). If allowOpposite is true, then the point can also snap to angle + pi radians.

Description

Projects the base Point to to the nearest point on the line defined by an input anchor point and input angle. ConstrainAngle is used by the editor to force a newly created Point to be on the line between a fixed point and a specified angle.

Remarks

ContrainAngle

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constrainAngle in interface IPoint

Parameters:: constraintAngle - The constraintAngle (in); anchor - A reference to a com.esri.arcgis.geometry.IPoint (in); allowOpposite - The allowOpposite (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPoint.constrainDistance(double, com.esri.arcgis.geometry.IPoint)

compare

public int compare(IPoint otherPoint)
            throws IOException,
                   AutomationException

Compares X, Y, M, Z, ID of this point (in that order) with that of the other point. Returns -1 if this point's value is less, 1 if greater, and 0 otherwise. Useful for sorting a group of points.

Description

Compares the location and attributes of the base point with those of the input point to determine a relative ordering of the two points. Compares point properties in the following order: X, Y, M, Z, and ID. Returns 1 if the base point possesses the first greater property, and returns -1 if the input point possesses the first greater property. This method takes the resolution of the spatial reference into account.

Remarks

The method should not be used in order to determine equality of two points. Use IRelationalOperator::Equals or IClone::IsEqual. At 9.2, this method uses the resolution property of the point's spatial reference in order to determine (x,y) coordinate ordering. At 9.1, an untoleranced (exact) comparison was performed.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: compare in interface IPoint

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

getGeometryType

public int getGeometryType()
                    throws IOException,
                           AutomationException

The type of this geometry.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getGeometryType in interface IGeometry

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

getDimension

public int getDimension()
                 throws IOException,
                        AutomationException

The topological dimension of this geometry.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getDimension in interface IGeometry

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

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference associated with this geometry.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSpatialReference in interface IGeometry

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

setSpatialReferenceByRef

public void setSpatialReferenceByRef(ISpatialReference spatialRef)
                              throws IOException,
                                     AutomationException

The spatial reference associated with this geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSpatialReferenceByRef in interface IGeometry

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

isEmpty

public boolean isEmpty()
                throws IOException,
                       AutomationException

Indicates whether this geometry contains any points.

Description

IsEmpty returns TRUE when the Geometry object does not contain geometric information beyond its original initialization state. An object may be returned to its original initialization (IsEmpty = TRUE) state using SetEmpty.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isEmpty in interface IGeometry

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

setEmpty

public void setEmpty()
              throws IOException,
                     AutomationException

Removes all points from this geometry.

Description

SetEmpty returns the Geometry to its original initialization state by releasing all data referenced by the Geometry.

Remarks

Use the SetEmpty method to clear geometries and release memory. For example, a polygon with 100 rings will have an internal array of 100 pointers to ring objects. That array will go away and Release will be called on each ring. If that polygon had the only reference on those rings, then they'll go away, which releases all their segments, which may also then go away.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setEmpty in interface IGeometry

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

queryEnvelope

public void queryEnvelope(IEnvelope outEnvelope)
                   throws IOException,
                          AutomationException

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryEnvelope in interface IGeometry

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

getEnvelope

public IEnvelope getEnvelope()
                      throws IOException,
                             AutomationException

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

Description

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

Remarks

Envelope Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEnvelope in interface IGeometry

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

project

public void project(ISpatialReference newReferenceSystem)
             throws IOException,
                    AutomationException

Projects this geometry into a new spatial reference.

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.

The Project method must be applied on high-level geometries only. High-Level geometries are point, multipoint, polyline and polygon. To use this method with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, B�zier Curve), paths or rings, they must be wrapped into high-level geometry types.

If a geometry is projected to a projected coordinate system that can't represent the geographic area where the geometry is located (or if trying to move an xy coordinate from outside the projected coordinate system back into geographic), the geometry will be set to empty.

Remarks

Note: This method can only be called upon the top level geometries (Points, Multipoints, Polylines and Polygons). 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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: project in interface IGeometry

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

snapToSpatialReference

public void snapToSpatialReference()
                            throws IOException,
                                   AutomationException

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

Remarks

SnapToSpatialReference rounds all coordinates to the resolution defined by the geometry's spatial reference system. This has a similar effect on the geometry as storing the geometry in a Geodatabase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: snapToSpatialReference in interface IGeometry

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

geoNormalize

public void geoNormalize()
                  throws IOException,
                         AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: geoNormalize in interface IGeometry

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

geoNormalizeFromLongitude

public void geoNormalizeFromLongitude(double longitude)
                               throws IOException,
                                      AutomationException

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: geoNormalizeFromLongitude in interface IGeometry

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

isMAware

public boolean isMAware()
                 throws IOException,
                        AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isMAware in interface IMAware

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

setMAware

public void setMAware(boolean mAware)
               throws IOException,
                      AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setMAware in interface IMAware

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

isMSimple

public boolean isMSimple()
                  throws IOException,
                         AutomationException

Indicates if all the Ms are valid numbers.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isMSimple in interface IMAware

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

dropMs

public void dropMs()
            throws IOException,
                   AutomationException

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: dropMs in interface IMAware

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

isZAware

public boolean isZAware()
                 throws IOException,
                        AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isZAware in interface IZAware

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

setZAware

public void setZAware(boolean zAware)
               throws IOException,
                      AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setZAware in interface IZAware

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

isZSimple

public boolean isZSimple()
                  throws IOException,
                         AutomationException

Indicates if all the Zs are valid numbers.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isZSimple in interface IZAware

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

dropZs

public void dropZs()
            throws IOException,
                   AutomationException

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: dropZs in interface IZAware

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

isPointIDAware

public boolean isPointIDAware()
                       throws IOException,
                              AutomationException

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

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isPointIDAware in interface IPointIDAware

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

setPointIDAware

public void setPointIDAware(boolean idAware)
                     throws IOException,
                            AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setPointIDAware in interface IPointIDAware

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

isPointIDSimple

public boolean isPointIDSimple()
                        throws IOException,
                               AutomationException

Indicates if all PointID values for this geometry are well-defined. Only works if geometry is aware of PointIDs.

Description

PointIDSimple is TRUE when all of the PointIDs are well defined (not equal to 0). If any PointIDs equal 0, PointIDSimple is FALSE.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isPointIDSimple in interface IPointIDAware

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

dropPointIDs

public void dropPointIDs()
                  throws IOException,
                         AutomationException

Unsets all PointID values without changing awareness. Only works if geometry is aware of PointIDs.

Description

Resets all PointID values to there initial value of 0. PointIDAware does not change.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: dropPointIDs in interface IPointIDAware

Throws:: 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 IOException,
                      AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryWKSEnvelope

public void queryWKSEnvelope(_WKSEnvelope[] e)
                      throws IOException,
                             AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryWKSEnvelope in interface IGeometry3

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

isChanged

public boolean isChanged()
                  throws IOException,
                         AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isChanged in interface IGeometry4

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

setChanged

public void setChanged(boolean isChanged)
                throws IOException,
                       AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setChanged in interface IGeometry4

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

project5

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

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.

Product Availability

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

Specified by:: project5 in interface IGeometry5

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

projectEx5

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

Same as ProjectEx, but with additional parameter projectionHint.

Description

Remarks

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getCentroidEx

public IPoint getCentroidEx()
                     throws IOException,
                            AutomationException

The center of gravity (centroid).

Product Availability

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

Specified by:: getCentroidEx in interface IGeometry5

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

move

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

Moves dx units horizontally and dy units vertically.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: move in interface ITransform2D

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

moveVector

public void moveVector(ILine v)
                throws IOException,
                       AutomationException

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: moveVector in interface ITransform2D

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

scale

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

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.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

rotate

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

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.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rotate in interface ITransform2D

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

transform

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

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

Product Availability

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

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

move3D

public void move3D(double dx,
                   double dy,
                   double dz)
            throws IOException,
                   AutomationException

Moves the object by dx, dy and dz along the x, y, and z axes respectively.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: move3D in interface ITransform3D

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

moveVector3D

public void moveVector3D(IVector3D v)
                  throws IOException,
                         AutomationException

Moves the object by an offset defined by a 3D vector.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: moveVector3D in interface ITransform3D

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

scale3D

public void scale3D(IPoint origin,
                    double sx,
                    double sy,
                    double sz)
             throws IOException,
                    AutomationException

Scales the object about the specified origin point. sx, sy, and sz are the scaling factors for the x, y, and z dimensions repectively.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: scale3D in interface ITransform3D

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

rotateVector3D

public void rotateVector3D(IVector3D axis,
                           double rotationAngle)
                    throws IOException,
                           AutomationException

Rotates the object about axis defined by the specified vector through an angle measured in radians.

Remarks

The angle of rotation must be in radians. To convert to radians from decimal degrees, multiply by PI/180.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: rotateVector3D in interface ITransform3D

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

transform3D

public void transform3D(int direction,
                        ITransformation3D transformation)
                 throws IOException,
                        AutomationException

Applies an arbitrary 3D transformation.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: transform3D in interface ITransform3D

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

projectToPlane

public IGeometry projectToPlane(IPoint planarOrigin,
                                IVector3D planarPositiveX,
                                IVector3D planarNorm)
                         throws IOException,
                                AutomationException

Generates a polygon footprint for the object in an arbitrary plane. The footprint may have multiple parts.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: projectToPlane in interface ITransform3D

Parameters:: planarOrigin - A reference to a com.esri.arcgis.geometry.IPoint (in); planarPositiveX - A reference to a com.esri.arcgis.geometry.IVector3D (in); planarNorm - A reference to a com.esri.arcgis.geometry.IVector3D (in)
Returns:: A reference to a com.esri.arcgis.geometry.IGeometry
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructAlong

public void constructAlong(ICurve curve,
                           int extension,
                           double distance,
                           boolean asRatio)
                    throws IOException,
                           AutomationException

Constructs a point distance units along the input curve.

Remarks

If the Distance parameter is less than zero, or greater than the length of the curve (when asRatio is false), or greater than one (when asRatio is true), then the value of the Extension parameter is used to determine the coordinates of the constructed point. In these cases, the point can be placed somewhere along an embedding geometry, or somewhere along a tangent geometry.

The embedding geometry of a straight line segment is a straight line extending infinitely in both directions. The embedding geometry of a circular arc is a complete circle. The embedding geometry of an elliptic arc is a complete ellipse. A bezier curve has no embedding geometry.

A tangent geometry is always a ray (a straight line extending infinitely in one direction) tangent to the input curve at either its from (start) or to (end) points.

Possible values for the Extension parameter are:
-------------------------------------------------
esriNoExtension The constructed point will always be on the input curve. A distance < 0 will pin the constructed point to the location of the input curve's from point. A distance > the curve length (or > 1 when asRatio is true) will pin the location to the curve's to point.

esriExtendTangentAtFrom If the distance parameter is < 0 then the point is constructed along a ray tangent to the start point of the curve, in a direction away from the curve.

esriExtendTangentAtTo If the distance parameter is greater than the length of the input curve (or > 1 when asRatio is true), then the constructed point is placed along a ray tangent to the end point of the curve, in a direction away from the curve.

esriExtendEmbeddedAtFrom Similar to the tangent option, but uses the embedding geometry instead of the tangent lines.

esriExtendEmbeddedAtTo Similar to the tangent option, but uses the embedding geometry instead of the tangent lines.

esriExtendEmbedded The point is constructed based on either the start or end points of the curve.

esriExtendTangents The point is tangential extended from the start or endpoint of the curve.

These values can be combined using the VB Or operator, or the C++ bitwise OR operator.

Example 1: esriExtendTangentAtFrom Or esriExtendTangentAtTo

Instead of using esriExtendTangents you could use esriExtendTangentAtFrom Or esriExtendTangentAtTo.This would allow the point to be constructed anywhere along infinte straight lines, beginning from either the start or end of the curve, regardless of whether the distance parameter was less than 0, or greater than the length of the input curve (or > 1 when asRatio is true).

ConstructPoint ConstructAlong Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructAlong in interface IConstructPoint

Parameters:: curve - A reference to a com.esri.arcgis.geometry.ICurve (in); extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); distance - The distance (in); asRatio - The asRatio (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructAngleDistance

public void constructAngleDistance(IPoint p,
                                   double inAngle,
                                   double distance)
                            throws IOException,
                                   AutomationException

Constructs a point at a specified angle (in radians) from the horizontal axis and a specified distance away from the input point.

Description

The ConstructAngleDistance method, given a point (p), construct another point at an angle (inangle) and a distance(distance).

Remarks

Angle in radians and distance in map units. The angle is measured counter-clockwise from the horizontal line and can be negative. If the distance is negative then the opposite direction is assumed (same as angle + PI).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructAngleDistance in interface IConstructPoint

Parameters:: p - A reference to a com.esri.arcgis.geometry.IPoint (in); inAngle - The inAngle (in); distance - The distance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IConstructPoint.constructAlong(com.esri.arcgis.geometry.ICurve, int, double, boolean)

constructDeflection

public void constructDeflection(ILine baseLine,
                                double distance,
                                double inAngle)
                         throws IOException,
                                AutomationException

Constructs a point in the polar coordinate system defined by baseLine and its 'from' point. The angle is in radians.

Description

The ConstructDeflection method, given a line (baseline), creates a new point at a distance (distance) and at an angle (inAngle).

Remarks

The point is constructed from the baseline start point using the deflection angle (the angle from the baseline to the point) and the distance. The deflection angle is given in radians the distance in map units. When distance is > 0, a positive value for angle rotates the constructed point counter-clockwise about the start point of baseline, and a negative value for angle rotates it the other way. Vice versa when distance is < 0.
ConstructDeflection Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructDeflection in interface IConstructPoint

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

constructDeflectionIntersection

public void constructDeflectionIntersection(ILine baseLine,
                                            double startAngle,
                                            double endAngle,
                                            boolean onRightSide)
                                     throws IOException,
                                            AutomationException

Constructs the point of intersection of two rays with origins at the endpoints of the base line and the specified angles (in radians). If onRightSide is true, this work will be done to the right of the base line, otherwise to the left.

Remarks

the bRightSide flag can be used to always force the constructed point to be on the right side of the baseline.

The startAngle is the angle (in radians) from the baseline's startpoint of the line to the constructed point. The endAngle is the angle (in radians) from the baseline's endpoint to the constructed point.

Both angles have to be > 0 and < 2 PI radians. Their sum must also be less than PI radians.

ConstructDeflectionIntersection Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructDeflectionIntersection in interface IConstructPoint

Parameters:: baseLine - A reference to a com.esri.arcgis.geometry.ILine (in); startAngle - The startAngle (in); endAngle - The endAngle (in); onRightSide - The onRightSide (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructThreePointResection

public void constructThreePointResection(IPoint point1,
                                         double angleP1P2,
                                         IPoint point2,
                                         double angleP2P3,
                                         IPoint point3,
                                         double[] arcAngle)
                                  throws IOException,
                                         AutomationException

Constructs the point of observation from which two signed angles between three points were measured; returns an angle which can help establish the confidence of the observation location: A small angle indicates greater uncertainty in the location.

Description

The ConstructThreePointResection method constructs a new point given three points and two signed view angles. It finds the viewpoints from which the two point pairs are viewed at the given angles. When both angles are equal to pi/2 radians, there is only one solution; otherwise there can be up to four solutions. A positive angle indicates that the viewpoint is to be on the right hand side of the line between the corresponding points; a negative angle places the resulting point on the left. There may not be a feasible solution for the given input, in which case the resulting point is empty. The quality of the solution is given by the arcAngle parameter. The smaller the angle the less stable the solution. The returned angle is between 0 and pi/2.

Remarks

Given three points and two angles measured from the constructed point.

Note that there is no unique solution if all three points are on the same circle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructThreePointResection in interface IConstructPoint

Parameters:: point1 - A reference to a com.esri.arcgis.geometry.IPoint (in); angleP1P2 - The angleP1P2 (in); point2 - A reference to a com.esri.arcgis.geometry.IPoint (in); angleP2P3 - The angleP2P3 (in); point3 - A reference to a com.esri.arcgis.geometry.IPoint (in); arcAngle - The arcAngle (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructOffset

public void constructOffset(ICurve curve,
                            int extension,
                            double distance,
                            boolean asRatio,
                            double offset)
                     throws IOException,
                            AutomationException

Constructs a point distance units along the input curve and offset units perpendicularly away from it.

Remarks

A positive Offset distance will create a point on the right side of the curve and a negative offset will create a point on the left side of the curve.

ConstructPoint ConstructOffset Example

Set the asRatio flag to be True if you want the distance to be a ratio of the curve length. If set to True, then a distance of 0.5 will be equal to half of the curve length (i.e. 50%).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructOffset in interface IConstructPoint

Parameters:: curve - A reference to a com.esri.arcgis.geometry.ICurve (in); extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); distance - The distance (in); asRatio - The asRatio (in); offset - The offset (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructParallel

public void constructParallel(ISegment segment,
                              int extension,
                              IPoint start,
                              double distance)
                       throws IOException,
                              AutomationException

Constructs a point distance units from start, parallel to the tangent at the point nearest to start on the (extended) segment.

Description

ConstructParallel constructs a Point a specified distance from the input point in the direction parallel to the tangent of the nearest point on the extended input segment.

Remarks

ConstructPoint ConstructParallel Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructParallel in interface IConstructPoint

Parameters:: segment - A reference to a com.esri.arcgis.geometry.ISegment (in); extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); start - A reference to a com.esri.arcgis.geometry.IPoint (in); distance - The distance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructAngleBisector

public void constructAngleBisector(IPoint from,
                                   IPoint through,
                                   IPoint to,
                                   double distance,
                                   boolean useAcuteAngle)
                            throws IOException,
                                   AutomationException

Constructs a point on the bisector of the angle (from, through, to). When useAcuteAngle is false, the sign of distance will select a point right or left of (from, through, to). Otherwise, the sign of distance will select the acute/obtuse point.

Description

Constructs a Point at specified Distance along the line which bisects the Angle formed by the right side of the three input points. If the right side angle is smaller, the constructed line along which the Point is constructed will always bisect this angle, regardless of the value of bUseSmallerAngle. However, if the right side angle is larger, and bUseSmallerAngle is TRUE, then the Point will be on the line constructed which bisects the smaller angle (left side) instead of the right side angle.

Remarks

The method uses a vector geometry to calculate the point. The Smaller Angle is the angle less than PI.

If From , To and Through points are all on a straight line , the point is calculated perpendicular (to the right) of the line.

Construct Angle Bisector

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructAngleBisector in interface IConstructPoint

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

constructPerpendicular

public void constructPerpendicular(ISegment base,
                                   int extension,
                                   IPoint p,
                                   double distance,
                                   boolean bUseLineOrientation)
                            throws IOException,
                                   AutomationException

Constructs a point 'distance' units from p and lying along the line normal to base and passing through p.

Description

ConstructPerpendicular constructs a Point a specified distance from the input point in the direction parallel to the normal (perpendicular to the tangent) of the nearest point on the extended input segment.

Remarks

ConstructPoint ConstructPerpendicular Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructPerpendicular in interface IConstructPoint

Parameters:: base - A reference to a com.esri.arcgis.geometry.ISegment (in); extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); p - A reference to a com.esri.arcgis.geometry.IPoint (in); distance - The distance (in); bUseLineOrientation - The bUseLineOrientation (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructAngleIntersection

public void constructAngleIntersection(IPoint p1,
                                       double angle1,
                                       IPoint p2,
                                       double angle2)
                                throws IOException,
                                       AutomationException

Constructs the point of intersection between two lines defined by the input points and angles (in radians).

Remarks

Angles are specified as geometric angles measured counterclockwise from the positive x axis of the Cartesian coordinate system. All angles are specified in radians .

ConstructAngleIntersection Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructAngleIntersection in interface IConstructPoint

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

constructAverage

public void constructAverage(IPointCollection points,
                             int attributeType)
                      throws IOException,
                             AutomationException

Constructs the geometric average of the input point collection. Optionally uses the specified attribute as a source of weights on the locations of the points.

Remarks

If attributeType is esriAttributeNone then the average point location is computed; otherwise the attribute specified by attributeType serves as a weight. Points whose weight attribute is NaN are ignored (a weight of 0 has a similar affect). The resulting point will have the (weighted) average for all their attributes. However this does not apply to ID's; no average is calculated for them in any case; but thay can be used as weight.

Only the following attributeType values are permitted: esriAttributeNone, esriAttributeZ, esriAttributeM, esriAttributeID.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructAverage in interface IConstructPoint2

Parameters:: points - A reference to a com.esri.arcgis.geometry.IPointCollection (in); attributeType - A com.esri.arcgis.geometry.esriGeometryAttributes constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

esri_equals

public boolean esri_equals(IGeometry other)
                    throws IOException,
                           AutomationException

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

Product Availability

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

Specified by:: esri_equals in interface IRelationalOperator

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

touches

public boolean touches(IGeometry other)
                throws IOException,
                       AutomationException

Indicates if the boundaries of the geometries intersect.

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.

If either one of the two geometries is empty, the geometries are not touched.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: touches in interface IRelationalOperator

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

contains

public boolean contains(IGeometry other)
                 throws IOException,
                        AutomationException

Indicates if this geometry contains the other geometry.

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.

An empty geometry does not contain another geometry. On the other hand, an empty geometry is contained in another geometry, unless the other geometry is empty.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: contains in interface IRelationalOperator

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

within

public boolean within(IGeometry other)
               throws IOException,
                      AutomationException

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

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.

An empty geometry is within another geometry, unless the other geometry is empty.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: within in interface IRelationalOperator

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

disjoint

public boolean disjoint(IGeometry other)
                 throws IOException,
                        AutomationException

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

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.

Two geometries are disjoint if either one is empty.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: disjoint in interface IRelationalOperator

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

crosses

public boolean crosses(IGeometry other)
                throws IOException,
                       AutomationException

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

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 or a point (for vertical line) 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.

If either one of the geometries is empty, the geometries do not cross.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: crosses in interface IRelationalOperator

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

overlaps

public boolean overlaps(IGeometry other)
                 throws IOException,
                        AutomationException

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

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.

Two geometries do not overlap if either one is empty.

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: overlaps in interface IRelationalOperator

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

relation

public boolean relation(IGeometry other,
                        String relationDescription)
                 throws IOException,
                        AutomationException

Indicates if the defined relationship exists.

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.

Remarks

Here is a VBA example of using the "RELATE" function to detect overlapping polylines. It assumes two polyline features are selected. G1 and G2 are placeholders for, in this example, the VBA variables r1 and r2.

Option Explicit

Public Sub overlapstest()
Dim ef As IEnumFeature
Dim d As IMxDocument
Set d = ThisDocument
Set ef = d.FocusMap.FeatureSelection
Dim r1 As IRelationalOperator, r2 As IRelationalOperator
Set r1 = ef.Next.Shape
Set r2 = ef.Next.Shape

Debug.Print "relation:", r1.Relation(r2, "RELATE(G1, G2, ""1********"")")

End Sub

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

containsEx

public boolean containsEx(IGeometry pOther,
                          int relation)
                   throws IOException,
                          AutomationException

Indicates if this geometry contains the other geometry, optionally using Celementini's definition.

Product Availability

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

Specified by:: containsEx in interface IRelationalOperator2

Parameters:: pOther - A reference to a com.esri.arcgis.geometry.IGeometry (in); relation - A com.esri.arcgis.geometry.esriSpatialRelationExEnum constant (in)
Returns:: The pbContains
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

withinEx

public boolean withinEx(IGeometry pOther,
                        int relation)
                 throws IOException,
                        AutomationException

Indicates if this geometry contains the other geometry, optionally using Celementini's definition.

Product Availability

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

Specified by:: withinEx in interface IRelationalOperator2

Parameters:: pOther - A reference to a com.esri.arcgis.geometry.IGeometry (in); relation - A com.esri.arcgis.geometry.esriSpatialRelationExEnum constant (in)
Returns:: The pbWithin
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isNear

public boolean isNear(IGeometry pOther,
                      double distance)
               throws IOException,
                      AutomationException

Indicates if this geometry is within distance from the other geometry.

Product Availability

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

Specified by:: isNear in interface IRelationalOperator2

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

queryNearestPoint

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: esriSegmentExtension, IProximityOperator.returnNearestPoint(com.esri.arcgis.geometry.IPoint, int)

returnNearestPoint

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

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: esriSegmentExtension, IProximityOperator.queryNearestPoint(com.esri.arcgis.geometry.IPoint, int, com.esri.arcgis.geometry.IPoint)

returnDistance

public double returnDistance(IGeometry other)
                      throws IOException,
                             AutomationException

Returns the minimum distance between two geometries.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: returnDistance in interface IProximityOperator

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

isSimple

public boolean isSimple()
                 throws IOException,
                        AutomationException

Indicates whether this geometry is known (or assumed) to be topologically correct, after explicitly determining this if the geometry is not already known (or assumed) to be simple.

Description

Returns TRUE if the geometry is topologically Simple (refer to the discussion for the Simplify method). If the geometry is not Simple, it may be necessary to call Simplify to enforce topological consistency. Editing a geometry can change the IsSimple state of the geometry.

Remarks

ITopologicalOperator methods must be applied on high-level geometries only. High-Level geometries are point, multipoint, polyline and polygon. To use this method with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, Bézier Curve), paths or rings, they must be wrapped into high-level geometries types.

The xy cluster tolerance value of the geometry's associated spatial reference is used by this method. If the goal of this method is to determine if a geometry can be persisted in an sde (or other integer-based) layer without alteration, you may wish to use the minimum xy cluster tolerance value (ISpatialReferenceTolerance::SetMinimumXYTolerance) before applying this method (don't forget to set it back).

This method does not support GeometryBags.

ITopologicalOperator IsSimple SimplePolygon Example

ITopologicalOperator IsSimple SimplePolyline Example

ITopologicalOperator IsSimple SimplePoint Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isSimple in interface ITopologicalOperator

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

isKnownSimple

public boolean isKnownSimple()
                      throws IOException,
                             AutomationException

Indicates whether this geometry is known (or assumed) to be topologically correct.

Description

Returns TRUE when the geometry is aware that it is Simple. IsKnownSimple may return FALSE even if the geometry is simple as long as the geometry is not aware of its IsSimple state. Calling either IsSimple or Simplify makes the IsSimple state known to the geometry. Topologically altering the geometry makes the IsKnownSimple state FALSE until the IsSimple state is again checked.

Remarks

Here is the status of the IsKnownSimple flag in some common situations:

IsKnownSimple = 'False'
- A non-empty newly created geometry. For example, creating a polygon using IPointCollection sets the flag IsKnownSimple = 'false' on that geometry.
- Geometry after projection (IGeometry::Project )
- Geometry after generalization (IPolycurve::Generalize ) or smoothing(IPolycurve::Smooth )
- �

IsKnownSimple = 'True'
- A geometry coming directly from a feature class
- An empty geometry
- Output geometry of any method on ITopologicalOperator
- �

This method does not support GeometryBags.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isKnownSimple in interface ITopologicalOperator

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

simplify

public void simplify()
              throws IOException,
                     AutomationException

Makes this geometry topologically correct.

Description

Simplify permanently alters the input geometry, making its definition "topologically legal" with respect to its geometry type:

For Points, Simplify does nothing. A point has no constraints on the values of its coordinates.
For Multipoints, Simplify snaps all X, Y, Z, and M coordinates to the grid of the associated spatial reference, then removes identical points. A point is identical to another point when the two have identical X and Y coordinates (after snapping), and when attributes for which it is aware are identical to the attributes for which the other point is aware. For example, if both points are Z aware, the Z coordinate values must be identical.
For Polylines, Simplify has two variations: planar and non-planar. By default, polylines that are not M-aware are simplified in a planar manner: all overlapping segments are reduced to a single segment, and segments are split at intersection points. Output paths are created for connected sequences of segments. Input segment orientation is preserved where possible, but segments in the interior of a path will be reoriented if necessary. Polylines that are M-aware use non-planar simplification: 1. Overlaps and self-intersections are preserved, but zero length segments are removed, 2. Segment orientations are adjusted so that the 'to' point of segment I is identical to (considering vertex attributes) the 'from' point of Segment I+1, 3. New paths are created where segments are not connected, 4. Existing paths are merged where only two of them meet at a segment endpoint.
For Polygons, Simplify identifies an interior and exterior for the polygon, then modifies the polygon structure to be consistent with that determination. The default methodology for identifying interior and exterior is: 1. Remove all dangling sequences of segments, 2. Identify the largest legal rings, add them to the output version of the polygon, then delete them from the working version, 3. Repeat. If this approach ends up removing too many segments for your application, consider using IPolygon4::SimplifyEx with the XOR parameter set to TRUE. At the end of Simplify, no rings will overlap, no self intersection will occur (except in certain circumstances) and, in general, an arbitrary point can always be classified unambiguously as either outside, on the boundary of, or inside the polygon.

The XY tolerance property of the geometry's associated spatial reference is used during the simplify operation for polylines and polygons.

Remarks

This method first looks at the ITopologicalOperator::IsKnownSimple flag before starting processing. If the flag is 'true' then operation is interrupted and the geometry is considered simple. If the flag is 'false' then the geometry consistency is checked and the geometry is updated as needed.

Simplify Polygon Example

Simplify Polyline Example

Simplify Point Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: simplify in interface ITopologicalOperator

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

buffer

public IGeometry buffer(double distance)
                 throws IOException,
                        AutomationException

Constructs a polygon that is the locus of points at a distance less than or equal to a specified distance from this geometry.

Remarks

The buffer distance is in the same units as the source shape that is being buffered.

A negative distance can be specified to produce a buffer inside the original polygon. This cannot be used with polyline. ITopologicalOperator methods must be applied on top-level geometries only. Top-Level geometries are point, multipoint, polyline and polygon. To use this method with segments (Line, Circular Arc, Elliptic Arc, Bézier Curve), paths or rings, they must be wrapped with a top-level type.

Buffer Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: buffer in interface ITopologicalOperator

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

convexHull

public IGeometry convexHull()
                     throws IOException,
                            AutomationException

Constructs the convex hull of this geometry.

Description

The ConvexHull of a geometry is the minimal bounding polygon such that all outer angles are convex. The ConvexHull of a point is the point itself.

Remarks

ITopologicalOperator methods must be applied on high-level geometries only. High-Level geometries are point, multipoint, polyline and polygon. To use this method with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, B�zier Curve), paths or rings, they must be wrapped into high-level geometries types.

This method does not support GeometryBags.

ConvexHull method does not deal with Z attribute now.

ConvexHull Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: convexHull in interface ITopologicalOperator

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

intersect

public IGeometry intersect(IGeometry other,
                           int resultDimension)
                    throws IOException,
                           AutomationException

Constructs the geometry that is the set-theoretic intersection of the input geometries. Use different resultDimension values to generate results of different dimensions.

Description

The Intersection of two Geometries of the same Dimension is a Geometry containing only the regions of overlap between the original geometries.

Remarks

Intersection is basically an AND between input geometries.

This method does not support GeometryBags.

Since ArcGIS 9.2, Intersect has a larger cost - it takes longer to run the method. Therefore, it is a better approach to test if the two geometries are disjoint before calling Intersect.

Intersection Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: intersect in interface ITopologicalOperator

Parameters:: other - A reference to a com.esri.arcgis.geometry.IGeometry (in); resultDimension - A com.esri.arcgis.geometry.esriGeometryDimension constant (in)
Returns:: A reference to a com.esri.arcgis.geometry.IGeometry
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IConstructMultipoint.constructIntersectionEx(com.esri.arcgis.geometry.ISegment, int, com.esri.arcgis.geometry.ISegment, int, double[], double[], int[]), IConstructMultipoint.constructIntersection(com.esri.arcgis.geometry.ISegment, int, com.esri.arcgis.geometry.ISegment, int, Object[], Object[], Object[]), ITopologicalOperator.intersect(com.esri.arcgis.geometry.IGeometry, int)

union

public IGeometry union(IGeometry other)
                throws IOException,
                       AutomationException

Constructs the geometry that is the set-theoretic union of the input geometries.

Description

The Union of two Geometries of the same Dimension is a single Geometry corresponding to the combination of both Geometries such that anything within either of the original geometries is also part of the unioned geometry, but anything common to both geometries only exists once in the unioned geometry.

Remarks

The Union is basically an OR between the input geometries.

This method does not support GeometryBags.

Union Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: union in interface ITopologicalOperator

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

constructUnion

public void constructUnion(IEnumGeometry geometries)
                    throws IOException,
                           AutomationException

Defines this geometry to be the union of the inputs. More efficient for unioning multiple geometries than calling Union repeatedly.

Description

ConstructUnion simultaneously Unions an Enumeration of geometries of the same Dimension into a single geometry. ConstructUnion is more efficient for unioning a large collection of geometries simultaneously rather than cycling through each geometry individually.

Remarks

This method does not support GeometryBags.

Temproray files might be created. If environment variable "ARCTMPDIR" exists, then the files are written to the path, otherwise written to current directory or system temp directory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructUnion in interface ITopologicalOperator

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

difference

public IGeometry difference(IGeometry other)
                     throws IOException,
                            AutomationException

Constructs the geometry containing points from this geometry but not the other geometry.

Description

Difference create a Geometry that is composed only of the region unique to the base geometry but not part of the input geometry.

Remarks

This method does not support GeometryBags.

ITopologicalOperator Differenece Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: difference in interface ITopologicalOperator

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

symmetricDifference

public IGeometry symmetricDifference(IGeometry other)
                              throws IOException,
                                     AutomationException

Constructs the geometry that contains points from either but not both input geometries.

Description

The SymmetricDifference between two Geometries of the same Dimension is the Union of those Geometries minus the Intersection of those Geometries. Thus, the SymmetricDifference is composed only of regions unique to only one of the geometries.

This method does not support GeometryBags.

Remarks

SymmetricDifference is basically an XOR between the input geometries.

SymmetricDifference of G1 and G2 can also be described as the Union(Difference(G1, G2), Difference(G2, G1)).

This method does not support GeometryBags.

Symmetric Difference Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: symmetricDifference in interface ITopologicalOperator

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

clip

public void clip(IEnvelope clipperEnvelope)
          throws IOException,
                 AutomationException

Constructs the intersection of this geometry and the specified envelope.

Description

The Clip method clips the geometry of the feature that is receiving the method call. The Clip method does not return an envelope. The geometry that is clipped will depend on what is Contained by the input clipperEnvelope.

Remarks

Use QueryClipped or QueryClippedDense methods to send the results to a different polygon.

ITopologicalOperator Clip Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clip in interface ITopologicalOperator

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

queryClipped

public void queryClipped(IEnvelope clipperEnvelope,
                         IGeometry clippedGeometry)
                  throws IOException,
                         AutomationException

Redefines clippedGeometry to be the intersection of this geometry and the clipping envelope.

Description

QueryClipped returns the portion of the input Geometry that is Contained by the input Envelope. The returned geometry is the same type as the original geometry.

Remarks

The other geometry must be an high-level geometry. High-Level geometries are point, multipoint, polyline and polygon. To use it with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, Bézier Curve), path or ring they must be wrapped into high-level geometries type. 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.

This method does not support GeometryBags.

QueryClipped Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryClipped in interface ITopologicalOperator

Parameters:: clipperEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in); clippedGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryClippedDense

public void queryClippedDense(IEnvelope clipperEnvelope,
                              double denseDistance,
                              IGeometry clippedGeometry)
                       throws IOException,
                              AutomationException

Redefines clippedGeometry to be the intersection of this geometry and the clipping envelope; densifies lines in the output contributed by the clipping envelope.

Remarks

ITopologicalOperator methods must be applied on high-level geometries only. High-Level geometries are point, multipoint, polyline and polygon. To use this method with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, B�zier Curve), paths or rings, they must be wrapped into high-level geometries types.

The other geometry must be an high-level geometry. High-Level geometries are point, multipoint, polyline and polygon. To use it with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, B�zier Curve), path or ring they must be wrapped into high-level geometries type. 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.

This method does not support GeometryBags.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryClippedDense in interface ITopologicalOperator

Parameters:: clipperEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in); denseDistance - The denseDistance (in); clippedGeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

cut

public void cut(IPolyline cutter,
                IGeometry[] leftGeom,
                IGeometry[] rightGeom)
         throws IOException,
                AutomationException

Splits this geometry into a part left of the cutting polyline, and a part right of it.

Remarks

When a polyline/polygon is cut, it is split where it intersects the cutter polyline. Each piece is classified as ‘left of’ or ‘right of’ the cutter. This classification is based on the orientation of the cutter line. Parts of the target polyline that do not intersect the cutting polyline are returned as part of the ‘right of’ result for that input polyline. If a geometry is not cut, the left geometry will be empty.

When using a multi-part polyline to cut a single ring of a polyline, the orientation of the polyline paths is important. The cut piece of the ring must be on the same side of each cutting path as defined by the orientation of each path.

This method does not support GeometryBags.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: cut in interface ITopologicalOperator

Parameters:: cutter - A reference to a com.esri.arcgis.geometry.IPolyline (in); leftGeom - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array); rightGeom - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getBoundary

public IGeometry getBoundary()
                      throws IOException,
                             AutomationException

The boundary of this geometry. A polygon's boundary is a polyline. A polyline's boundary is a multipoint. A point or multipoint's boundary is an empty point or multipoint.

Description

The Boundary of a Geometry is the part one the exterior of the Geometry. The Boundary is one Dimension lower than the Dimension of the original Geometry. The Boundary of a Polygon are the Polylines that form the Rings of the Polygon. The Boundary of a Polyline is a Multipoint corresponding to the endpoints of each Path in the Polyline. The Boundary of a Multipoint is an empty set.

Remarks

This method does not support GeometryBags.

Boundary Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getBoundary in interface ITopologicalOperator

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

clipDense

public void clipDense(IEnvelope clipperEnvelope,
                      double denseDistance)
               throws IOException,
                      AutomationException

Constructs the intersection of this geometry and the specified envelope; densifies lines in output contributed by the clipping envelope.

Remarks

ITopologicalOperator methods must be applied on high-level geometries only. High-Level geometries are point, multipoint, polyline and polygon. To use this method with low-level geometries such as segments (Line, Circular Arc, Elliptic Arc, B�zier Curve), paths or rings, they must be wrapped into high-level geometries types.

This method does not support GeometryBags.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: clipDense in interface ITopologicalOperator

Parameters:: clipperEnvelope - A reference to a com.esri.arcgis.geometry.IEnvelope (in); denseDistance - The denseDistance (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

constructUnionEx

public void constructUnionEx(IEnumGeometry pEnum,
                             boolean bNonPlanar)
                      throws IOException,
                             AutomationException

Defines this geometry to be the union of the inputs, with the option for non-planary result.

Product Availability

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

Specified by:: constructUnionEx in interface ITopologicalOperator6

Parameters:: pEnum - A reference to a com.esri.arcgis.geometry.IEnumGeometry (in); bNonPlanar - The bNonPlanar (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

intersectEx

public IGeometry intersectEx(IGeometry other,
                             boolean bNonPlanar,
                             int resultDimension)
                      throws IOException,
                             AutomationException

Constructs the set-theoretic intersection of the inputs in the specified result dimension, , with the option for non-planary result.

Product Availability

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

Specified by:: intersectEx in interface ITopologicalOperator6

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

unionEx

public IGeometry unionEx(IGeometry other,
                         boolean bNonPlanar)
                  throws IOException,
                         AutomationException

Constructs the set-theoretic union of the inputs, with the option for non-planary result.

Product Availability

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

Specified by:: unionEx in interface ITopologicalOperator6

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

intersectMultidimensionEx

public IGeometry intersectMultidimensionEx(IGeometry other,
                                           boolean bNonPlanar)
                                    throws IOException,
                                           AutomationException

Constructs the set-theoretic intersection of the inputs. The results are returned in a geometry bag with one element per result dimension.

Product Availability

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

Specified by:: intersectMultidimensionEx in interface ITopologicalOperator6

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

differenceEx

public IGeometry differenceEx(IGeometry other,
                              boolean bNonPlanar)
                       throws IOException,
                              AutomationException

defined for (multi)points and polylines.

Product Availability

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

Specified by:: differenceEx in interface ITopologicalOperator6

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

symmetricDifferenceEx

public IGeometry symmetricDifferenceEx(IGeometry other,
                                       boolean bNonPlanar)
                                throws IOException,
                                       AutomationException

defined for (multi)points and polylines.

Product Availability

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

Specified by:: symmetricDifferenceEx in interface ITopologicalOperator6

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

simplifyAsFeature

public void simplifyAsFeature()
                       throws IOException,
                              AutomationException

Simplifies the geometry using the rules appropriate for this feature.

Product Availability

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

Specified by:: simplifyAsFeature in interface ITopologicalOperator6

Throws:: 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 IOException,
                       AutomationException

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

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hitTest3D

public boolean hitTest3D(IPoint queryPoint,
                         double searchRadius,
                         int geometryPart,
                         IPoint hitPoint,
                         double[] hitDistance,
                         int[] hitPartIndex,
                         int[] hitSegmentIndex)
                  throws IOException,
                         AutomationException

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

Product Availability

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

Specified by:: hitTest3D in interface IHitTest3D

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)
Returns:: The bHit
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

hitTestCone

public boolean hitTestCone(IRay pQueryRay,
                           double minAngle,
                           int geometryPart,
                           IPoint pHitPoint,
                           double[] pHitDistance,
                           int[] pHitPartIndex,
                           int[] pHitSegmentIndex)
                    throws IOException,
                           AutomationException

Locates a part of a geometry closest to a query ray.

Product Availability

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

Specified by:: hitTestCone in interface IHitTest3D

Parameters:: pQueryRay - A reference to a com.esri.arcgis.geometry.IRay (in); minAngle - The minAngle (in); geometryPart - A com.esri.arcgis.geometry.esriGeometryHitPartType constant (in); pHitPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); pHitDistance - The pHitDistance (in/out: use single element array); pHitPartIndex - The pHitPartIndex (in/out: use single element array); pHitSegmentIndex - The pHitSegmentIndex (in/out: use single element array)
Returns:: The pbHit
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: interfaceSupportsErrorInfo in interface ISupportErrorInfo

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

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getClassID in interface IPersist

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

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isDirty in interface IPersistStream

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

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: load in interface IPersistStream

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

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: save in interface IPersistStream

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

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSizeMax in interface IPersistStream

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

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:: esri_clone in interface IClone

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

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: assign in interface IClone

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

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isEqual in interface IClone

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

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isIdentical in interface IClone

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

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: serialize in interface IXMLSerialize

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

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: deserialize in interface IXMLSerialize

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

putCoordsFromMGRS

public void putCoordsFromMGRS(String mgrs,
                              int mode)
                       throws IOException,
                              AutomationException

Creates the coordinates of a point from the MGRS/USNG description.

Description

Creates the coordinates of a point from the MGRS/USNG string description. MGRS stands for military grid reference system while USNG is the United States National Grid. The Point being used must already have a defined spatial reference. The coordinate system cannot be unknown. PutCoordsFromMGRS takes two inputs. The first is the MGRS string that you want to convert. The second is the esriMGRSModeEnum and determines how to handle the geographic coordinate system of the spatial reference. Certain older geographic coordinate systems will cause one of the letters of the string to be shifted. This process makes it easier to identify coordinates that are based on a non-WGS84 datum.

esriMGRSModeEnum:

esriMGRSMode_Automatic: the geographic coordinate system is handled for you

esriMGRSMode_NewStyle: the geographic coordinate system is treated as if it is WGS84

esriMGRSMode_NewWith180InZone01: the geographic coordinate system is treated as if it is WGS84 and a point at 180E will be forced into UTM zone 1.

esriMGRSMode_OldStyle: the geographic coordinate system is treated as if it is an older non-WGS84 datum, particularly one that is based on the Clarke 1866 or Bessel spheroids.

esriMGRSMode_OldWith180InZone01: the geographic coordinate system is treated as if it is an older non-WGS84 datum, particularly one that is based on the Clarke 1866 or Bessel spheroids and a point at 180E will be forced into UTM zone 1.

esriMGRSMode_USNG: USNG does not differentiate between older and newer geographic coordinate systems.

Product Availability

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

Specified by:: putCoordsFromMGRS in interface IConversionMGRS

Parameters:: mgrs - The mgrs (in); mode - A com.esri.arcgis.geometry.esriMGRSModeEnum constant (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

createMGRS

public String createMGRS(int numDigits,
                         boolean round,
                         int mode)
                  throws IOException,
                         AutomationException

Returns the MGRS/USNG description of a point.

Description

This method creates a single string description in MGRS/USNG for any Point on the Earth's surface. A string variable is needed to store this alphanumeric string. MGRS stands for military grid reference system while USNG is the United States National Grid. CreateMGRS takes three inputs.

The first is the integer number of digits you wish the string to carry and controls the precision.

0: To approximately 100 kilometers depending on where on earth the point is.

5: To a square meter (This is the standard for MGRS/USNG).

8: To a square millimeter. This is the best precision possible and using a larger number will not result in greater precision.

The second input parameter is a boolean that represents rounding.

True: The values of the UTM coordinates will be rounded.

False: The values of the UTM coordinates will be truncated.

The second is the esriMGRSModeEnum and determines how to handle the geographic coordinate system of the spatial reference. Certain older geographic coordinate systems will cause one of the letters of the string to be shifted. This process makes it easier to identify coordinates that are based on a non-WGS84 datum.

esriMGRSModeEnum:

esriMGRSMode_Automatic: the geographic coordinate system is handled for you

esriMGRSMode_NewStyle: the geographic coordinate system is treated as if it is WGS84

esriMGRSMode_NewWith180InZone01: the geographic coordinate system is treated as if it is WGS84 and a point at 180E will be forced into UTM zone 1.

esriMGRSMode_OldStyle: the geographic coordinate system is treated as if it is an older non-WGS84 datum, particularly one that is based on the Clarke 1866 or Bessel spheroids.

esriMGRSMode_USNG: USNG does not differentiate between older and newer geographic coordinate systems.

Product Availability

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

Specified by:: createMGRS in interface IConversionMGRS

Parameters:: numDigits - The numDigits (in); round - The round (in); mode - A com.esri.arcgis.geometry.esriMGRSModeEnum constant (in)
Returns:: The mgrs
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getUSNGFromCoords

public String getUSNGFromCoords(int numDigits,
                                boolean numericRounding,
                                boolean addSpaces)
                         throws IOException,
                                AutomationException

Returns the USNG description of a point.

Description

The GetUSNGFromCoords method returns a USNG string. The United States National Grid (USNG) is a simplified version of the Military Grid Reference System (MGRS) and is an alphanumeric way to represent a location. The Point must have a spatial reference that includes a coordinate system. It does not have to a be a geographic coordinate system. The precision parameter controls the length of the string. The sample USNG string below has a precision of 5 which means it is to the closest meter. The geographic coordinates are using the WGS 1984 geographic coordinate system. The first two numbers in the string are the UTM zone number.

latitude = 40.0

longitude = -100.0

USNG = 14TMK1463928236

Product Availability

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

Specified by:: getUSNGFromCoords in interface IConversionNotation

Parameters:: numDigits - The numDigits (in); numericRounding - The numericRounding (in); addSpaces - The addSpaces (in)
Returns:: The uSNGString
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getUTMFromCoords

public String getUTMFromCoords(int utmOptions)
                        throws IOException,
                               AutomationException

Returns the UTM description of a point.

Product Availability

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

Specified by:: getUTMFromCoords in interface IConversionNotation

Parameters:: utmOptions - A com.esri.arcgis.geometry.esriUTMConversionOptionsEnum constant (in)
Returns:: The uTMString
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getGARSFromCoords

public String getGARSFromCoords()
                         throws IOException,
                                AutomationException

Returns the GARS description of a point.

Description

The GetGARSFromCoords method returns an alphanumeric string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The Global Area Reference System (GARS) is used for military referencing. More information is at http://earth-info.nga.mil/GandG/coordsys/grids/gars.html

longitude = -100.0

latitude = 40.0

GARS = 161LW37

Product Availability

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

Specified by:: getGARSFromCoords in interface IConversionNotation

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

getGeoRefFromCoords

public String getGeoRefFromCoords(int numDigits,
                                  boolean numericRounding)
                           throws IOException,
                                  AutomationException

Returns the GeoRef description of a point.

Description

The GetGeoRefFromCoords method returns an alphanumeric string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The World Geographic Reference System (GEOREF) is used for military referencing. More information is at http://earth-info.nga.mil/GandG/coordsys/grids/referencesys.html.

longitude = -100.0

latitude = 40.0

Georef = FJFL000000 (precision is 3 which determines a location to 0.1 minute)

Product Availability

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

Specified by:: getGeoRefFromCoords in interface IConversionNotation

Parameters:: numDigits - The numDigits (in); numericRounding - The numericRounding (in)
Returns:: The geoRefString
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDDFromCoords

public String getDDFromCoords(int precision)
                       throws IOException,
                              AutomationException

Returns the decimal degrees description of a point.

Description

The GetDDFromCoords method returns a formatted string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The returned values are in decimal degrees and have direction (hemisphere) information. The precision parameter controls the number of decimal places used in the output values. The sample output below has a precision of 6.

longitude = -100.0 latitude = 40.0 Output = "40.000000N 100.000000W"

Product Availability

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

Specified by:: getDDFromCoords in interface IConversionNotation

Parameters:: precision - The precision (in)
Returns:: The dDString
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDDMFromCoords

public String getDDMFromCoords(int precision)
                        throws IOException,
                               AutomationException

Returns the degrees decimal minutes description of a point.

Description

The GetDDMFromCoords method returns a formatted string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The returned values are in degrees and decimal minutes and have direction (hemisphere) information. The precision parameter controls the number of decimal places used in the output decimal minute values. The sample output below has a precision of 4.

longitude = -100.0 latitude = 40.0 output = "40 00.0000N 100 00.0000W"

Product Availability

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

Specified by:: getDDMFromCoords in interface IConversionNotation

Parameters:: precision - The precision (in)
Returns:: The dDMString
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getDMSFromCoords

public String getDMSFromCoords(int precision)
                        throws IOException,
                               AutomationException

Returns the degrees/minutes/seconds description of a point.

Description

The GetDMSFromCoords method returns a formatted string from a Point that has either geographic or projected coordinates. The Point must have a spatial reference that has a defined coordinate system. The returned values are in degrees minutes and decimal seconds and have direction (hemisphere) information. The precision parameter controls the number of decimal places used in the output second values. The sample below has a precision of 4.

longitude = -100.0 latitude = 40.0 Output = "40 00 00.0000N 100 00 00.0000W"

Product Availability

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

Specified by:: getDMSFromCoords in interface IConversionNotation

Parameters:: precision - The precision (in)
Returns:: The dMSString
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

putCoordsFromUSNG

public void putCoordsFromUSNG(String uSNGString)
                       throws IOException,
                              AutomationException

Creates the coordinates of a point from the USNG description.

Product Availability

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

Specified by:: putCoordsFromUSNG in interface IConversionNotation

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

putCoordsFromUTM

public void putCoordsFromUTM(int utmOptions,
                             String uTMString)
                      throws IOException,
                             AutomationException

Creates the coordinates of a point from the UTM description.

Product Availability

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

Specified by:: putCoordsFromUTM in interface IConversionNotation

Parameters:: utmOptions - A com.esri.arcgis.geometry.esriUTMConversionOptionsEnum constant (in); uTMString - The uTMString (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

putCoordsFromGARS

public void putCoordsFromGARS(int mode,
                              String gARSString)
                       throws IOException,
                              AutomationException

Creates the coordinates of a point from the GARS description.

Product Availability

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

Specified by:: putCoordsFromGARS in interface IConversionNotation

Parameters:: mode - A com.esri.arcgis.geometry.esriGARSModeEnum constant (in); gARSString - The gARSString (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

putCoordsFromGeoRef

public void putCoordsFromGeoRef(String geoRefString)
                         throws IOException,
                                AutomationException

Creates the coordinates of a point from the GeoRef description.

Product Availability

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

Specified by:: putCoordsFromGeoRef in interface IConversionNotation

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

putCoordsFromDD

public void putCoordsFromDD(String dDString)
                     throws IOException,
                            AutomationException

Creates the coordinates of a point from the decimal degrees description.

Product Availability

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

Specified by:: putCoordsFromDD in interface IConversionNotation

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

putCoordsFromDDM

public void putCoordsFromDDM(String dDMString)
                      throws IOException,
                             AutomationException

Creates the coordinates of a point from the degrees decimal minutes description.

Product Availability

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

Specified by:: putCoordsFromDDM in interface IConversionNotation

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

putCoordsFromDMS

public void putCoordsFromDMS(String dMSString)
                      throws IOException,
                             AutomationException

Creates the coordinates of a point from the degrees/minutes/seconds description.

Product Availability

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

Specified by:: putCoordsFromDMS in interface IConversionNotation

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

snap

public void snap()
          throws IOException,
                 AutomationException

Snaps ms to the precision of the spatial reference associated with the geometry. M snapping does not happen automatically as part of calling IGeometry::SnapToSpatialReference.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: snap in interface IMSnap

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

queryNearestPoint3D

public void queryNearestPoint3D(IPoint pInP,
                                int extension,
                                IPoint pNearest)
                         throws IOException,
                                AutomationException

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

Description

Queries the nearest point on a z aware geometry to the input point in 3D space. Depending on the method of segment extension, the nearest point can also be found on an extension of the geometry.

Remarks

If the geometry is an Envelope and the input point is located within the bounds of the Envelope, QueryNearestPoint3D will return a point on the exterior of the Envelope nearest the input point.

Product Availability

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

Specified by:: queryNearestPoint3D in interface IProximityOperator3D

Parameters:: pInP - A reference to a com.esri.arcgis.geometry.IPoint (in); extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); pNearest - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

returnNearestPoint3D

public IPoint returnNearestPoint3D(IPoint pInP,
                                   int extension)
                            throws IOException,
                                   AutomationException

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

Description

Finds and returns the nearest point, in 3D space, on a z aware 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

If the geometry is an Envelope and the input point is located within the bounds of the Envelope, QueryNearestPoint3D will return a point on the exterior of the Envelope nearest the input point.

Product Availability

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

Specified by:: returnNearestPoint3D in interface IProximityOperator3D

Parameters:: pInP - 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:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

returnDistance3D

public double returnDistance3D(IGeometry pOther)
                        throws IOException,
                               AutomationException

Returns the minimal distance between two geometries.

Description

Returns the minimum distance between two z aware geometries in 3D space. If the geometries intersect, the minimum distance is 0. Only returns the distance, and not the nearest points.

Product Availability

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

Specified by:: returnDistance3D in interface IProximityOperator3D

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

disjoint3D

public boolean disjoint3D(IGeometry pOther)
                   throws IOException,
                          AutomationException

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

Description

Determines whether two z aware geometries intersect in 3D space. Two geometries are disjoint if their intersection is empty. Two geometries intersect if disjoint is FALSE.

Product Availability

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

Specified by:: disjoint3D in interface IRelationalOperator3D

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

isNear3D

public boolean isNear3D(IGeometry pOther,
                        double distance)
                 throws IOException,
                        AutomationException

Indicates if this geometry is within distance from the other geometry; both geometries must have Zs.

Product Availability

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

Specified by:: isNear3D in interface IRelationalOperator3D2

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

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:: writeExternal in interface Externalizable

Throws:: IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:: readExternal in interface Externalizable

Throws:: IOException; ClassNotFoundException

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 Point

Product Availability

Supported Platforms

Point

Point

getClsid

equals

hashCode

queryCoords

Product Availability

Supported Platforms

putCoords

Remarks

Product Availability

Supported Platforms

getX

Description

Product Availability

Supported Platforms

setX

Product Availability

Supported Platforms

getY

Description

Remarks

Product Availability

Supported Platforms

setY

Product Availability

Supported Platforms

getZ

Description

Product Availability

Supported Platforms

setZ

Product Availability

Supported Platforms

getM

Description

Remarks

Product Availability

Supported Platforms

setM

Product Availability

Supported Platforms

getID

Description

Remarks

Example:

Product Availability

Supported Platforms

setID

Product Availability

Supported Platforms

constrainDistance

Description

Remarks

Product Availability

Supported Platforms

constrainAngle

Description

Remarks

Product Availability

Supported Platforms

compare

Description

Remarks

Product Availability

Supported Platforms

getGeometryType

Remarks

Product Availability

Supported Platforms

getDimension

Description

Remarks

Product Availability

Supported Platforms

getSpatialReference

Description

com.esri.arcgis.geometry
Class Point