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

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

All Implemented Interfaces:: IArea, IConstructPath, ICurve, ICurve3D, IGeometry, IPath, IPointCollection, IPointCollection2, IPointCollection3, IPointCollection4, IRing, IRing2, ISegmentCollection, ITransform2D, ITransform3D, com.esri.arcgis.interop.RemoteObjRef, IClone, ISupportErrorInfo, IXMLSerialize, Serializable

public class Ring
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPointCollection, IPointCollection4, IGeometry, ISegmentCollection, IArea, ICurve, IPath, IRing, IRing2, IConstructPath, ISupportErrorInfo, IClone, ITransform2D, ITransform3D, IXMLSerialize, ICurve3D
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IPointCollection, IPointCollection4, IGeometry, ISegmentCollection, IArea, ICurve, IPath, IRing, IRing2, IConstructPath, ISupportErrorInfo, IClone, ITransform2D, ITransform3D, IXMLSerialize, ICurve3D

An area bounded by one, closed sequence of connected segments; optionally has measure, height and ID attributes at each vertex.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:: Serialized Form

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

Method Summary
`void`	`addPoint(IPoint inPoint, Object before, Object after)` Adds a vertex to a Path, Ring, Polyline, or Polygon; or adds a reference to the input point to a Multipoint, TriangleFan, or TriangleStrip.
`void`	`addPointCollection(IPointCollection newPoints)` Adds copies of points in the input point collection to this Path, Ring, Polyline, or Polygon; or adds references to the points in the collection to this Multipoint, TriangleFan, or TriangleStrip.
`void`	`addPoints(int count, IPoint newPoints)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.addPoints(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.geometry.IPoint[])`.
`void`	`addSegment(ISegment inSegment, Object before, Object after)` Adds a reference to the input segment at the end, or before or after a specified index.
`void`	`addSegmentCollection(ISegmentCollection segments)` Adds references to the segments from the specified segment collection.
`void`	`addSegments(int count, ISegment newSegments)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.addSegments(com.esri.arcgis.geometry.ISegmentCollection, com.esri.arcgis.geometry.ISegment[])`.
`void`	`addWKSPointZs(int count, _WKSPointZ pointStructures)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.addWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.system._WKSPointZ[])`.
`void`	`assign(IClone src)` Assigns the properties of src to the receiver.
`void`	`close()` Makes sure that this ring is closed by adding a line segment between the ring's 'to' and 'from' points if necessary.
`void`	`constructRigidStretch(IPath srcPath, int stretchStartIndex, int startAnchor, int endAnchor, IPoint stretchEnd)` Constructs a scaled, rotated version of srcPath.
`void`	`deserialize(IXMLSerializeData data)` Deserializes an object from XML.
`boolean`	`equals(Object o)` Compare this object with another
`IClone`	`esri_clone()` Clones the receiver and assigns the result to *clone.
`void`	`generalize(double maxAllowableOffset)` Generalizes this path using the Douglas-Poiker algorithm.
`void`	`geoNormalize()` Shifts longitudes, if need be, into a continuous range of 360 degrees.
`void`	`geoNormalizeFromLongitude(double longitude)` Normalizes longitudes into a continuous range containing the longitude.
`double`	`getArea()` The area.
`IPoint`	`getCentroid()` The center of gravity (centroid).
`static String`	`getClsid()` getClsid.
`int`	`getDimension()` The topological dimension of this geometry.
`IEnumCurve`	`getEnumCurve()` A new curve enumerator for this segment collection.
`IEnumSegment`	`getEnumSegments()` A new enumerator for this segment collection.
`IEnumVertex`	`getEnumVertices()` A new enumerator for this point collection.
`IEnvelope`	`getEnvelope()` Creates a copy of this geometry's envelope and returns it.
`IPoint`	`getFromPoint()` The 'from' point of the curve.
`int`	`getGeometryType()` The type of this geometry.
`IEnumSegment`	`getIndexedEnumSegments(IGeometry queryGeometry)` A new indexed segment enumerator for this segment collection.
`IEnumVertex`	`getIndexedEnumVertices(IGeometry queryGeometry)` An indexed vertex enumerator for this point collection.
`IPoint`	`getLabelPoint()` A point guaranteed to be inside this area.
`double`	`getLength()` The length of the curve.
`double`	`getLength3D()` The length of the curve.
`IPoint`	`getPoint(int i)` A copy of the ith vertex of a Path, Ring, Polyline, or Polygon; or a reference to the ith point of a Multipoint, TriangleFan, or TriangleStrip.
`int`	`getPointCount()` The number of points in the collection.
`void`	`getPoints(int index, int count, IPoint[] points)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.getPoints(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.geometry.IPoint[][])`.
`ISegment`	`getSegment(int i)` A reference to the ith segment.
`int`	`getSegmentCount()` The number of segments.
`ISpatialReference`	`getSpatialReference()` The spatial reference associated with this geometry.
`void`	`getSubcurve(double fromDistance, double toDistance, boolean asRatio, ICurve[] outSubcurve)` Extracts a portion of this curve into a new curve.
`void`	`getSubcurve3D(double fromDistance, double toDistance, boolean bAsRatio, ICurve3D[] ppOutSubCurve)` Extracts a portion of this curve into a new curve.
`ICurve`	`getSubcurveEx(double fromDistance, double toDistance, boolean asRatio, boolean isCCW, boolean useRingOrientation)` Extracts a portion of this curve into a new curve.
`IPoint`	`getToPoint()` The 'to' point of the curve.
`int`	`hashCode()` the hashcode for this object
`void`	`hasNonLinearSegments(boolean[] nonLinearSegments)` Indicates if this segment collection contains segments other than lines.
`void`	`insertPointCollection(int index, IPointCollection newPoints)` Inserts copies of points, from the input point collection, as vertices into this Path, Ring, Polyline, or Polygon; or references to points in the input point collection into this Multipoint, TriangleFan, or TriangleStrip.
`void`	`insertPoints(int index, int count, IPoint newPoints)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.insertPoints(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.geometry.IPoint[])`.
`void`	`insertSegmentCollection(int index, ISegmentCollection newSegments)` Inserts references to the segments in the input collectoin.
`void`	`insertSegmentCollectionEx(int index, int start, int count, ISegmentCollection newSegments)` Inserts references to some of the segments from the input collection.
`void`	`insertSegments(int index, int count, ISegment newSegments)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.insertSegments(com.esri.arcgis.geometry.ISegmentCollection, int, com.esri.arcgis.geometry.ISegment[])`.
`void`	`insertWKSPointZs(int index, int count, _WKSPointZ newPoints)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.insertWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.system._WKSPointZ[])`.
`void`	`interfaceSupportsErrorInfo(GUID riid)` interfaceSupportsErrorInfo
`boolean`	`isClosed()` Indicates if 'from' and 'to' points (of each part) are identical.
`boolean`	`isClosed3D()` Indicates if 'from' and 'to' points (of each part) are identical.
`boolean`	`isEmpty()` Indicates whether this geometry contains any points.
`boolean`	`isEqual(IClone other)` Indicates if the receiver and other have the same properties.
`boolean`	`isExterior()` Indicates if this ring can function as the exterior ring in a polygon (ring orientation is clockwise, area > 0).
`boolean`	`isIdentical(IClone other)` Indicates if the receiver and other are the same object.
`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.
`void`	`project(ISpatialReference newReferenceSystem)` Projects this geometry into a new spatial reference.
`IGeometry`	`projectToPlane(IPoint planarOrigin, IVector3D planarPositiveX, IVector3D planarNorm)` Generates a polygon footprint for the object in an arbitrary plane.
`void`	`queryCentroid(IPoint center)` Copies the centroid of this area to the specified point.
`void`	`queryChordLengthTangents(int pointIndex, IPoint prevTangent, boolean[] prevSetByUser, IPoint nextTangent, boolean[] nextSetByUser)` Returns tangent vectors (relative to corresponding endpoint) at both sides of a Bezier end point; and whether they have been set by user or by smoothing process.
`void`	`queryEnvelope(IEnvelope outEnvelope)` Copies this geometry's envelope properties into the specified envelope.
`void`	`queryFromPoint(IPoint from)` Copies this curve's 'from' point to the input point.
`void`	`queryLabelPoint(IPoint labelPoint)` Copies to the input point a point guaranteed to be inside this area.
`void`	`queryNormal(int extension, double distanceAlongCurve, boolean asRatio, double length, ILine normal)` Constructs a line normal to a curve from a point at a specified distance along the curve.
`void`	`queryPoint(int extension, double distanceAlongCurve, boolean asRatio, IPoint outPoint)` Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.
`void`	`queryPoint(int index, IPoint point)` Queries for a point in the PointCollection at given index.
`void`	`queryPoint3D(int extension, double distanceAlongCurve, boolean bAsRatio, IPoint pOutPoint)` Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.
`void`	`queryPointAndDistance(int extension, IPoint inPoint, boolean asRatio, IPoint outPoint, double[] distanceAlongCurve, double[] distanceFromCurve, boolean[] bRightSide)` Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.
`void`	`queryPointAndDistance3D(int extension, IPoint pInPoint, boolean bAsRatio, IPoint pOutPoint, double[] pDistanceAlongCurve, double[] pDistanceFromCurve)` Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.
`void`	`queryPoints(int index, int count, IPoint points)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.queryPoints(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.geometry.IPoint[][])`.
`void`	`querySegments(int index, int count, ISegment[] segments)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.querySegments(com.esri.arcgis.geometry.ISegmentCollection, int, com.esri.arcgis.geometry.ISegment[][])`.
`void`	`queryTangent(int extension, double distanceAlongCurve, boolean asRatio, double length, ILine tangent)` Constructs a line tangent to a curve from a point at a specified distance along the curve.
`void`	`queryToPoint(IPoint to)` Copies the curve's 'to' point into the input point.
`void`	`queryWKSPointZs(int index, int count, _WKSPointZ[] pointStructures)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.queryWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.system._WKSPointZ[][])`.
`void`	`removePoints(int index, int count)` Removes vertices from a Path, Ring, Polyline, or Polygon, or references to points from a Multipoint, TriangleFan, or TriangleStrip.
`void`	`removeSegments(int index, int count, boolean closeGap)` Removes references to some segments.
`void`	`replacePointCollection(int index, int goingAway, IPointCollection newPoints)` Replaces vertices/points within a PointCollection.
`void`	`replacePoints(int index, int comingIn, int goingAway, IPoint newPoints)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.replacePoints(com.esri.arcgis.geometry.IPointCollection4, int, int, com.esri.arcgis.geometry.IPoint[])`.
`void`	`replaceSegmentCollection(int index, int goingAway, ISegmentCollection newSegments)` Remove and inserts some segments.
`void`	`replaceSegments(int index, int comingIn, int goingAway, ISegment newSegments)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.replaceSegments(com.esri.arcgis.geometry.ISegmentCollection, int, int, com.esri.arcgis.geometry.ISegment[])`.
`boolean`	`reshape(IPath reshapeSource)` Modifies this ring by replacing some of its segments with some segments from reshapeSource.
`void`	`reshapeEx(IPath reshapeSource, IGeometry[] leftResult, IGeometry[] rightResult)` Creates two new polygons by using segments from the ring and from reshapeSource.
`void`	`reverseOrientation()` Reverses the parameterization of the curve ('from' point becomes 'to' point, first segment becomes last segment, etc).
`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`	`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`	`segmentsChanged()` Informs the segment collection that any cached values that it may be maintaining (envelope, length, etc.) are invalid.
`void`	`serialize(IXMLSerializeData data)` Serializes an object to XML.
`void`	`setChordLengthTangents(int pointIndex, IPoint prevTangent, IPoint nextTangent)` Sets tangent vectors (relative to corresponding endpoint) at both sides of a Bezier end point; if either is Nothing, they will be set by smoothing process.
`void`	`setCircle(IPoint cp, double circleRadius)` Defines this path, ring, polyline or polygon to contain a single circular arc segment that is closed.
`void`	`setEmpty()` Removes all points from this geometry.
`void`	`setFromPoint(IPoint from)` The 'from' point of the curve.
`void`	`setPointCollection(IPointCollection newPoints)` Replaces all vertices of this Path, Ring, Polyline, or Polygon with copies of the points in the input collection; or all points of this Multipoint, TriangleFan, or TriangleStrip with references to points from the input collection.
`void`	`setPoints(int count, IPoint newPoints)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.setPoints(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.geometry.IPoint[])`.
`void`	`setRectangle(IEnvelope inEnvelope)` Defines this path, ring, polyline or polygon to have four line segments in the same positions as the sides of the input envelope.
`void`	`setSegmentCollection(ISegmentCollection newSegments)` Replaces all segments with references to segments from the input collection.
`void`	`setSegments(int count, ISegment newSegments)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.setSegments(com.esri.arcgis.geometry.ISegmentCollection, com.esri.arcgis.geometry.ISegment[])`.
`void`	`setSpatialReferenceByRef(ISpatialReference spatialRef)` The spatial reference associated with this geometry.
`void`	`setToPoint(IPoint to)` The 'to' point of the curve.
`void`	`setWKSPointZs(int count, _WKSPointZ pointStructures)` Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by `GeometryEnvironment.setWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.system._WKSPointZ[])`.
`void`	`smooth(double maxAllowableOffset)` Converts this path into a smooth approximation of itself that contains only Bezier curve segments.
`void`	`smoothLocal(int vertexIndex)` Replaces up to four segments (two on each of the specified vertex index) with bezier curves.
`void`	`snapToSpatialReference()` Moves points of this geometry so that they can be represented in the precision of the geometry's associated spatial reference system.
`void`	`transform(int direction, ITransformation transformation)` Applies an arbitrary transformation.
`void`	`transform3D(int direction, ITransformation3D transformation)` Applies an arbitrary 3D transformation.
`void`	`updatePoint(int i, IPoint p)` Changes the ith vertex or point to be a copy of the input point.

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

Ring

public Ring()
     throws IOException,
            UnknownHostException

Constructs a Ring using ArcGIS Engine.

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

Ring

public Ring(Object obj)
     throws IOException

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

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

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

getPointCount

public int getPointCount()
                  throws IOException,
                         AutomationException

The number of points in the collection.

Description

Returns the number of Points in the PointCollection. The last Point in the PointCollection has an index equal to PointCount - 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPointCount in interface IPointCollection

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

getPoint

public IPoint getPoint(int i)
                throws IOException,
                       AutomationException

A copy of the ith vertex of a Path, Ring, Polyline, or Polygon; or a reference to the ith point of a Multipoint, TriangleFan, or TriangleStrip.

Product Availability

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

Specified by:: getPoint in interface IPointCollection

Parameters:: i - The i (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.

addPoint

public void addPoint(IPoint inPoint,
                     Object before,
                     Object after)
              throws IOException,
                     AutomationException

Adds a vertex to a Path, Ring, Polyline, or Polygon; or adds a reference to the input point to a Multipoint, TriangleFan, or TriangleStrip.

Description

Adds a Point to a PointCollection. If before and after are omitted, the Point is added to the end of the PointCollection. Additionally, by specifying either the before or after index, the Point can be added at a specific location in the PointCollection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addPoint in interface IPointCollection

Parameters:: inPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); before - A Variant (in, optional, pass null if not required); after - A Variant (in, optional, pass null if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

updatePoint

public void updatePoint(int i,
                        IPoint p)
                 throws IOException,
                        AutomationException

Changes the ith vertex or point to be a copy of the input point.

Description

Updates the ith Point with a copy of the input Point. Update replaces the reference to the indexed point with a reference to the input Point.

Remarks

For efficiency UpdatePoint does not check if the spatial reference of the input point is equal to the spatial reference of the PointCollection. Please make sure that the spatial reference of the input point is equal to the spatial reference of the PointCollection before you pass the point in.

Note : You can also explicitly check the spatial reference by using IClone::IsEqual

Example:

//To check spatial reference efficiently
IPoint pointIn = null;
IPointCollection ptColl = null;
ISpatialReference pSpatialReferenceOfCollection = null;

//The next line will not do anything if the two projections are equal
pointIn.project(pSpatialReferenceOfCollection);
ptColl.updatePoint( 1, pointIn);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: updatePoint in interface IPointCollection

Parameters:: i - The i (in); p - 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.

queryPoints

public void queryPoints(int index,
                        int count,
                        IPoint points)
                 throws IOException,
                        AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.queryPoints(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.geometry.IPoint[][]).

Copies some points to an existing array of points. This method is intended for internal use only.

Description

Queries a specified number (Count) of Points starting at the given index into an array of Points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryPoints in interface IPointCollection

Parameters:: index - The index (in); count - The count (in); points - 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.

insertPoints

public void insertPoints(int index,
                         int count,
                         IPoint newPoints)
                  throws IOException,
                         AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.insertPoints(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.geometry.IPoint[]).

Inserts copies of the input points as vertices into a Path, Ring, Polyline, or Polygon; or references to the input points into a Multipoint, TriangleFan, or TriangleStrip. This method is intended for internal use only.

Description

Inserts a specified number (Count) of Points into the PointCollection at the given index from an array of Points. The first Count points from the array are inserted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insertPoints in interface IPointCollection

Parameters:: index - The index (in); count - The count (in); newPoints - 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.

insertPointCollection

public void insertPointCollection(int index,
                                  IPointCollection newPoints)
                           throws IOException,
                                  AutomationException

Inserts copies of points, from the input point collection, as vertices into this Path, Ring, Polyline, or Polygon; or references to points in the input point collection into this Multipoint, TriangleFan, or TriangleStrip.

Description

Inserts a PointCollection of Points into the PointCollection at the specified index. The resulting PointCollection does not retain information about the distinction between the old and new Point Collections.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insertPointCollection in interface IPointCollection

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

addPoints

public void addPoints(int count,
                      IPoint newPoints)
               throws IOException,
                      AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.addPoints(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.geometry.IPoint[]).

Adds copies of the input points as vertices to this Path, Ring, Polyline, or Polygon; or references to the input points to this Multipoint, TriangleFan, or TriangleStrip. This method is intended for internal use only.

Description

Adds the first specified number (Count) of Points to the PointCollection from an array of Points (with at least Count points). The Points are all added to the end of the PointCollection in the same sequence as they are ordered in the array.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addPoints in interface IPointCollection

Parameters:: count - The count (in); newPoints - 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.

addPointCollection

public void addPointCollection(IPointCollection newPoints)
                        throws IOException,
                               AutomationException

Adds copies of points in the input point collection to this Path, Ring, Polyline, or Polygon; or adds references to the points in the collection to this Multipoint, TriangleFan, or TriangleStrip.

Description

Adds a PointCollection of Points to the end of the PointCollection. The resulting PointCollection does not retain the division between the old PointCollection and the additional PointCollection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addPointCollection in interface IPointCollection

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

setPoints

public void setPoints(int count,
                      IPoint newPoints)
               throws IOException,
                      AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.setPoints(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.geometry.IPoint[]).

Replaces all existing vertices of this Path, Ring, Polyline, or Polygon with copies of the input points; or all existing points of this Multipoint, TriangleFan, or TriangleStrip with references to the input points (for C++ and VB users only).

Description

Sets the contents of the PointCollection equal to the first Count Points from the input array of Points. After SetPoints is called, the PointCollection contains only count Points from the input Point array (regardless of what it may have contained previously).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setPoints in interface IPointCollection

Parameters:: count - The count (in); newPoints - 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.

setPointCollection

public void setPointCollection(IPointCollection newPoints)
                        throws IOException,
                               AutomationException

Replaces all vertices of this Path, Ring, Polyline, or Polygon with copies of the points in the input collection; or all points of this Multipoint, TriangleFan, or TriangleStrip with references to points from the input collection.

Description

Sets the contents of the PointCollection equal to the contents of the input PointCollection. After SetPointCollection is called, the PointCollection contains only the Points from the input PointCollection (regardless of what it may have contained previously).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setPointCollection in interface IPointCollection

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

removePoints

public void removePoints(int index,
                         int count)
                  throws IOException,
                         AutomationException

Removes vertices from a Path, Ring, Polyline, or Polygon, or references to points from a Multipoint, TriangleFan, or TriangleStrip.

Description

Removes a specified number (Count) of Points from a PointCollection starting at a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removePoints in interface IPointCollection

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

getEnumVertices

public IEnumVertex getEnumVertices()
                            throws IOException,
                                   AutomationException

A new enumerator for this point collection.

Description

Returns an EnumVertex for the vertices in the PointCollection. The EnumVertex allows the Points to be tranversed in a sequential order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEnumVertices in interface IPointCollection

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

replacePoints

public void replacePoints(int index,
                          int comingIn,
                          int goingAway,
                          IPoint newPoints)
                   throws IOException,
                          AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.replacePoints(com.esri.arcgis.geometry.IPointCollection4, int, int, com.esri.arcgis.geometry.IPoint[]).

Replaces vertices/points within a PointCollection.

Description

Removes a specified number (goingAway) of Points from a PointCollection starting at a given index and replaces them (starting at the same index) with a specified number (comingIn) of Points from an array of Points.

If you are using attempting to use this method from a .NET enabled language, such as VB.NET, you may need to use the ReplacePoints method provided by the IGeometryBridge interface exposed on the GeometryEnvironment object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: replacePoints in interface IPointCollection

Parameters:: index - The index (in); comingIn - The comingIn (in); goingAway - The goingAway (in); newPoints - 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.

replacePointCollection

public void replacePointCollection(int index,
                                   int goingAway,
                                   IPointCollection newPoints)
                            throws IOException,
                                   AutomationException

Replaces vertices/points within a PointCollection.

Description

Replaces a specified number (goingAway) of Points in the PointCollection begining at a given index with a PointCollection of Points (inserted at the given index).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: replacePointCollection in interface IPointCollection

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

queryPoint

public void queryPoint(int index,
                       IPoint point)
                throws IOException,
                       AutomationException

Queries for a point in the PointCollection at given index.

Description

Queries the ith Point from the PointCollection. The first Point in the PointCollection has index 0, and the last Point has index equal to PointCount - 1. (Alternatively, the last Point in the PointCollection can be referenced using index -1.).

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.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryPoint in interface IPointCollection

Parameters:: index - The index (in); point - 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.

addWKSPointZs

public void addWKSPointZs(int count,
                          _WKSPointZ pointStructures)
                   throws IOException,
                          AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.addWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.system._WKSPointZ[]).

Adds vertices/points to this Path, Ring, Polyline, Polygon, Multipoint, TriangleFan, Triangles, TriangleStrip, or MultiPatch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addWKSPointZs in interface IPointCollection4

Parameters:: count - The count (in); pointStructures - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setWKSPointZs

public void setWKSPointZs(int count,
                          _WKSPointZ pointStructures)
                   throws IOException,
                          AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.setWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, com.esri.arcgis.system._WKSPointZ[]).

Replaces all vertices/points of this Path, Ring, Polyline, Polygon, Multipoint, TriangleFan, Triangles, TriangleStrip, or MultiPatch with new ones.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setWKSPointZs in interface IPointCollection4

Parameters:: count - The count (in); pointStructures - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryWKSPointZs

public void queryWKSPointZs(int index,
                            int count,
                            _WKSPointZ[] pointStructures)
                     throws IOException,
                            AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.queryWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.system._WKSPointZ[][]).

Copies vertices/points coordinates to the array of point structures.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryWKSPointZs in interface IPointCollection4

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

insertWKSPointZs

public void insertWKSPointZs(int index,
                             int count,
                             _WKSPointZ newPoints)
                      throws IOException,
                             AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.insertWKSPointZs(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.system._WKSPointZ[]).

Inserts new vertices/points into this Path, Ring, Polyline, Polygon, Multipoint, TriangleFan, Triangles, TriangleStrip, or MultiPatch.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insertWKSPointZs in interface IPointCollection4

Parameters:: index - The index (in); count - The count (in); newPoints - A Structure: com.esri.arcgis.system._WKSPointZ (A com.esri.arcgis.system._WKSPointZ COM typedef) (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

getIndexedEnumVertices

public IEnumVertex getIndexedEnumVertices(IGeometry queryGeometry)
                                   throws IOException,
                                          AutomationException

An indexed vertex enumerator for this point collection.

Product Availability

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

Specified by:: getIndexedEnumVertices in interface IPointCollection3

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

getPoints

public void getPoints(int index,
                      int count,
                      IPoint[] points)
               throws IOException,
                      AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.getPoints(com.esri.arcgis.geometry.IPointCollection4, int, com.esri.arcgis.geometry.IPoint[][]).

Populates an array with references to points in the Multipoint. The QueryPoints method on IPointCollection makes copies of the points. This method is intended for internal use only.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getPoints in interface IPointCollection2

Parameters:: index - The index (in); count - The count (in); points - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)
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

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.

getSegmentCount

public int getSegmentCount()
                    throws IOException,
                           AutomationException

The number of segments.

Description

Returns the number of Segments in the Segment Collection. The last Segment in the Segment Collection has an index equal to SegmentCount - 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSegmentCount in interface ISegmentCollection

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

getSegment

public ISegment getSegment(int i)
                    throws IOException,
                           AutomationException

A reference to the ith segment.

Product Availability

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

Specified by:: getSegment in interface ISegmentCollection

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

addSegment

public void addSegment(ISegment inSegment,
                       Object before,
                       Object after)
                throws IOException,
                       AutomationException

Adds a reference to the input segment at the end, or before or after a specified index.

Description

Adds a Segment to a Segment Collection. If before and after are omitted, the Segment is added to the end of the Segment Collection. Additionally, by specifying either the before or after index, the Segment can be added at a specific location in the Segment Collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addSegment in interface ISegmentCollection

Parameters:: inSegment - A reference to a com.esri.arcgis.geometry.ISegment (in); before - A Variant (in, optional, pass null if not required); after - A Variant (in, optional, pass null if not required)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

querySegments

public void querySegments(int index,
                          int count,
                          ISegment[] segments)
                   throws IOException,
                          AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.querySegments(com.esri.arcgis.geometry.ISegmentCollection, int, com.esri.arcgis.geometry.ISegment[][]).

Returns references to some of the input segments. This method is intended for internal use only.

Description

Queries a specified number (Count) of Segments starting at the given index into an array of Segments.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: querySegments in interface ISegmentCollection

Parameters:: index - The index (in); count - The count (in); segments - A reference to a com.esri.arcgis.geometry.ISegment (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

addSegments

public void addSegments(int count,
                        ISegment newSegments)
                 throws IOException,
                        AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.addSegments(com.esri.arcgis.geometry.ISegmentCollection, com.esri.arcgis.geometry.ISegment[]).

Adds references to segments. This method is intended for internal use only.

Description

Adds the first specified number (Count) of Segments to the Segment Collection from an array of Segments (with at least Count segments). The Segments are all added to the end of the Segment Collection in the same sequence as they are ordered in the array.

Remarks

Note: the array must contains only ISegment pointers, otherwise it night crash the application.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addSegments in interface ISegmentCollection

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

addSegmentCollection

public void addSegmentCollection(ISegmentCollection segments)
                          throws IOException,
                                 AutomationException

Adds references to the segments from the specified segment collection.

Description

Adds a Segment Collection of Segments to the end of the existing Segment Collection. It is assumed that the From Point of the new Segment Collection is the same as the To Point of the existing Segment Collection.

Remarks

AddSegmentCollection add the other geometry to the last part of the current geometry.
For example, adding a polyline (with one part) to another polyline (with one part)
is adding the second polyline segments into the first part of the other polyline
even if the polylines are disjoint.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: addSegmentCollection in interface ISegmentCollection

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

insertSegments

public void insertSegments(int index,
                           int count,
                           ISegment newSegments)
                    throws IOException,
                           AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.insertSegments(com.esri.arcgis.geometry.ISegmentCollection, int, com.esri.arcgis.geometry.ISegment[]).

Inserts references to the input segments. This method is intended for internal use only.

Description

Inserts a specified number (Count) of Segments into the Segment Collection at the given index from an array of Segments. The first Count segments from the array are inserted.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insertSegments in interface ISegmentCollection

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

insertSegmentCollection

public void insertSegmentCollection(int index,
                                    ISegmentCollection newSegments)
                             throws IOException,
                                    AutomationException

Inserts references to the segments in the input collectoin.

Description

Inserts a Segment Collection of segments into the Segment Collection at the specified index. The resulting Segment Collection does not retain information about the distinction between the old and new Segment Collections.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insertSegmentCollection in interface ISegmentCollection

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

insertSegmentCollectionEx

public void insertSegmentCollectionEx(int index,
                                      int start,
                                      int count,
                                      ISegmentCollection newSegments)
                               throws IOException,
                                      AutomationException

Inserts references to some of the segments from the input collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: insertSegmentCollectionEx in interface ISegmentCollection

Parameters:: index - The index (in); start - The start (in); count - The count (in); newSegments - A reference to a com.esri.arcgis.geometry.ISegmentCollection (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

replaceSegments

public void replaceSegments(int index,
                            int comingIn,
                            int goingAway,
                            ISegment newSegments)
                     throws IOException,
                            AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.replaceSegments(com.esri.arcgis.geometry.ISegmentCollection, int, int, com.esri.arcgis.geometry.ISegment[]).

Removes and inserts from segments. This method is intended for internal use only.

Description

Removes a specified number (goingAway) of Segments from a Segment Collection starting at a given index and replaces them (starting at the same index) with a specified number (comingIn) of Segments from an array of Segments.

Remarks

ReplaceSegments will return an error ("The index is either too large or too small") if the inputs are inconsistent. For example, specifying index = 4 on a polyline with only 2 segments.

On multipart geometry, segments cannot be replaced on more than one part at the time. For example, an error (("The index is either too large or too small") is returned on a polyline with two parts containing three segments each when specifying index= 2, incoming= 2, removal= 2. The error is returned because the first part doesn't contain enough segments to remove two segments starting at index = 2. This behavior is enforced for performance reasons. Please see the example.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: replaceSegments in interface ISegmentCollection

Parameters:: index - The index (in); comingIn - The comingIn (in); goingAway - The goingAway (in); newSegments - A reference to a com.esri.arcgis.geometry.ISegment (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

replaceSegmentCollection

public void replaceSegmentCollection(int index,
                                     int goingAway,
                                     ISegmentCollection newSegments)
                              throws IOException,
                                     AutomationException

Remove and inserts some segments.

Description

Replaces a specified number (goingAway) of Segments in the Segment Collection begining at a given index with a Segment Collection of Segments (inserted at the given index).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: replaceSegmentCollection in interface ISegmentCollection

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

removeSegments

public void removeSegments(int index,
                           int count,
                           boolean closeGap)
                    throws IOException,
                           AutomationException

Removes references to some segments. If closeGap is TRUE, then any remaining internal gap in the path, ring, polyline or polygon is connected with a single line segment.

Description

Removes a specified number (Count) of Segments from a Segment Collection starting at a given index.
If the removal created a disjoint Path and if closeGap is TRUE, then the remaining segments will
be connected at the midpoint of the gap by modifying the segments adjacent to the gap.This will create a
connected Path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: removeSegments in interface ISegmentCollection

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

setCircle

public void setCircle(IPoint cp,
                      double circleRadius)
               throws IOException,
                      AutomationException

Defines this path, ring, polyline or polygon to contain a single circular arc segment that is closed.

Description

Sets a SegmentCollection equal to a single segment CircularArc. The CircularArc is a complete circle centered at the input point with a given input Radius. After SetCircle is called, the SegmentCollection contains only the CiruclarArc (regardless of what it may have contained previously). The To and From Points at located at the top (Pi/2 Radians) of the circle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setCircle in interface ISegmentCollection

Parameters:: cp - A reference to a com.esri.arcgis.geometry.IPoint (in); circleRadius - The circleRadius (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IConstructCircularArc.constructCircle(com.esri.arcgis.geometry.IPoint, double, boolean), ISegmentCollection.setCircle(com.esri.arcgis.geometry.IPoint, double)

setRectangle

public void setRectangle(IEnvelope inEnvelope)
                  throws IOException,
                         AutomationException

Defines this path, ring, polyline or polygon to have four line segments in the same positions as the sides of the input envelope.

Description

Sets the contents of the SegmentCollection equal to four Line segments that form the sides of the input Envelope. The Segments begin with the LowerLeft point and proceed clockwise (the first side is the left side). After SetRectangle is called, the SegmentCollection contains only the 4 Line segments (regardless of what it may have contained previously). The spatial reference of the envelope is transferred to the SegmentCollection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setRectangle in interface ISegmentCollection

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

setSegments

public void setSegments(int count,
                        ISegment newSegments)
                 throws IOException,
                        AutomationException

Deprecated. This method uses C style arrays which are not supported in the ArcGIS API for Java. It is replaced by GeometryEnvironment.setSegments(com.esri.arcgis.geometry.ISegmentCollection, com.esri.arcgis.geometry.ISegment[]).

Replaces all segments with references to the input segments. This method is intended for internal use only.

Description

Sets the contents of the Segment Collection equal to the first Count segments from the input array of Segments. After SetSegments is called, the Segment Collection contains only count segments from the input Segment array (regardless of what it may have contained previously).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSegments in interface ISegmentCollection

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

setSegmentCollection

public void setSegmentCollection(ISegmentCollection newSegments)
                          throws IOException,
                                 AutomationException

Replaces all segments with references to segments from the input collection.

Description

Sets the contents of the Segment Collection equal to the contents of the input Segment Collection. After SetSegmentCollection is called, the Segment Collection contains only the segments from the input Segment Collection (regardless of what it may have contained previously).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setSegmentCollection in interface ISegmentCollection

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

getEnumSegments

public IEnumSegment getEnumSegments()
                             throws IOException,
                                    AutomationException

A new enumerator for this segment collection.

Description

Returns an IEnumSegment enumerator for the current SegmentCollection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEnumSegments in interface ISegmentCollection

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

getEnumCurve

public IEnumCurve getEnumCurve()
                        throws IOException,
                               AutomationException

A new curve enumerator for this segment collection.

Description

Returns an IEnumCurve enumerator for the current SegmentCollection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getEnumCurve in interface ISegmentCollection

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

hasNonLinearSegments

public void hasNonLinearSegments(boolean[] nonLinearSegments)
                          throws IOException,
                                 AutomationException

Indicates if this segment collection contains segments other than lines.

Description

Returns TRUE if the Segment Collection contains CircularArcs, BezierCurves, or EllipticArcs. Returns FALSE if all segments are Lines.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: hasNonLinearSegments in interface ISegmentCollection

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

getIndexedEnumSegments

public IEnumSegment getIndexedEnumSegments(IGeometry queryGeometry)
                                    throws IOException,
                                           AutomationException

A new indexed segment enumerator for this segment collection.

Product Availability

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

Specified by:: getIndexedEnumSegments in interface ISegmentCollection

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

segmentsChanged

public void segmentsChanged()
                     throws IOException,
                            AutomationException

Informs the segment collection that any cached values that it may be maintaining (envelope, length, etc.) are invalid. Use this method after editing segments directly.

Description

SegmentsChanged forces the SegmentCollection to recalculate any values that it has cached. SegmentsChanged should be used whenever the Segments in the SegmentCollection are modified without using the SegmentCollection methods. As long as the SegmentCollection is only modified using SegmentCollection methods, the cached values are current and consistent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: segmentsChanged in interface ISegmentCollection

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

getArea

public double getArea()
               throws IOException,
                      AutomationException

The area.

Description

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

Remarks

Area Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getArea in interface IArea

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

getCentroid

public IPoint getCentroid()
                   throws IOException,
                          AutomationException

The center of gravity (centroid).

Description

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

Remarks

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

Centroid Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getCentroid in interface IArea

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:: IArea.queryCentroid(com.esri.arcgis.geometry.IPoint), IArea.getCentroid(), IArea.queryLabelPoint(com.esri.arcgis.geometry.IPoint), IArea.getLabelPoint()

getLabelPoint

public IPoint getLabelPoint()
                     throws IOException,
                            AutomationException

A point guaranteed to be inside this area.

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLabelPoint in interface IArea

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:: IArea.queryCentroid(com.esri.arcgis.geometry.IPoint), IArea.getCentroid(), IArea.queryLabelPoint(com.esri.arcgis.geometry.IPoint), IArea.getLabelPoint()

queryCentroid

public void queryCentroid(IPoint center)
                   throws IOException,
                          AutomationException

Copies the centroid of this area to the specified point.

Description

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

Dim pPoint as IPoint

Set pPoint = New Point

Remarks

Centroid Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryCentroid in interface IArea

Parameters:: center - 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:: IArea.queryCentroid(com.esri.arcgis.geometry.IPoint), IArea.getCentroid(), IArea.queryLabelPoint(com.esri.arcgis.geometry.IPoint), IArea.getLabelPoint()

queryLabelPoint

public void queryLabelPoint(IPoint labelPoint)
                     throws IOException,
                            AutomationException

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

Description

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


Dim pPoint as IPoint

Set pPoint = New Point

Remarks

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryLabelPoint in interface IArea

Parameters:: labelPoint - 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:: IArea.queryCentroid(com.esri.arcgis.geometry.IPoint), IArea.getCentroid(), IArea.queryLabelPoint(com.esri.arcgis.geometry.IPoint), IArea.getLabelPoint()

getLength

public double getLength()
                 throws IOException,
                        AutomationException

The length of the curve.

Description

Returns the length of the entire curve. The length of the curve is the sum of the lengths along each parameterized Segment between vertices along the curve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getLength in interface ICurve

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

getFromPoint

public IPoint getFromPoint()
                    throws IOException,
                           AutomationException

The 'from' point of the curve.

Description

Returns or Sets the FromPoint of the first segment of the first part of the curve. While the curve may be composed of many parts and segments each with their own FromPoint, each curve only has a single From Point.

Remarks

FromPoint Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getFromPoint in interface ICurve

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:: IPoint, ICurve.queryFromPoint(com.esri.arcgis.geometry.IPoint), ICurve.getFromPoint(), ICurve.queryToPoint(com.esri.arcgis.geometry.IPoint), ICurve.getToPoint()

setFromPoint

public void setFromPoint(IPoint from)
                  throws IOException,
                         AutomationException

The 'from' point of the curve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setFromPoint in interface ICurve

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

queryFromPoint

public void queryFromPoint(IPoint from)
                    throws IOException,
                           AutomationException

Copies this curve's 'from' point to the input point.

Description

Used to query the FromPoint of the first Segment of the first part of the curve.

Remarks

QueryFromPoint Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryFromPoint in interface ICurve

Parameters:: from - 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:: IPoint, ICurve.queryFromPoint(com.esri.arcgis.geometry.IPoint), ICurve.getFromPoint(), ICurve.queryToPoint(com.esri.arcgis.geometry.IPoint), ICurve.getToPoint()

getToPoint

public IPoint getToPoint()
                  throws IOException,
                         AutomationException

The 'to' point of the curve.

Description

Returns or Sets the ToPoint of the first Segment of the first part of the curve. While the curve may be composed of many parts and segments each with their own ToPoint, each curve only has a single To Point.

Remarks

ToPoint Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getToPoint in interface ICurve

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:: IPoint, ICurve.queryFromPoint(com.esri.arcgis.geometry.IPoint), ICurve.getFromPoint(), ICurve.queryToPoint(com.esri.arcgis.geometry.IPoint), ICurve.getToPoint()

setToPoint

public void setToPoint(IPoint to)
                throws IOException,
                       AutomationException

The 'to' point of the curve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setToPoint in interface ICurve

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

queryToPoint

public void queryToPoint(IPoint to)
                  throws IOException,
                         AutomationException

Copies the curve's 'to' point into the input point.

Description

Used to query the ToPoint of the first Segment of the first part of the curve.

Remarks

QueryToPoint Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryToPoint in interface ICurve

Parameters:: to - 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:: IPoint, ICurve.queryFromPoint(com.esri.arcgis.geometry.IPoint), ICurve.getFromPoint(), ICurve.queryToPoint(com.esri.arcgis.geometry.IPoint), ICurve.getToPoint()

queryPoint

public void queryPoint(int extension,
                       double distanceAlongCurve,
                       boolean asRatio,
                       IPoint outPoint)
                throws IOException,
                       AutomationException

Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.

Description

Returns the Point at a given distance along the curve or extended curve. If the distance is less than the length of the curve, then the returned point is the point at that distance along the curve. If the distance is less than zero, or greater than the length of the curve, then the returned point is on the curve specified by the extension method. The distance may be specified as a fixed unit of measure or a ratio of the length of the curve.

Remarks

ICurve QueryPoint Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryPoint in interface ICurve

Parameters:: extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); distanceAlongCurve - The distanceAlongCurve (in); asRatio - The asRatio (in); outPoint - 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:: IPoint, esriSegmentExtension

queryPointAndDistance

public void queryPointAndDistance(int extension,
                                  IPoint inPoint,
                                  boolean asRatio,
                                  IPoint outPoint,
                                  double[] distanceAlongCurve,
                                  double[] distanceFromCurve,
                                  boolean[] bRightSide)
                           throws IOException,
                                  AutomationException

Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.

Description

Finds the Point on the specified extended curve nearest to the input point and the distance between those points. Also returns information about the side of the curve the input point is on as well as the distance along the curve that the nearest point occurs.

Remarks

AsRatio is an input parameter that only affects the DistanceAlongCurve

distanceFromCurve is an output parameter that represents the minimum distance between the curve and the input point.

DistanceAlongCurve is an output parameter that represents the distance between the Frompoint of the input curve and the returned point on the curve.

bRightSide is an output parameter that tells if the output point is on the right side of the curve. The direction of the curve determines the right and left sides.

QueryPointAndDistance Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryPointAndDistance in interface ICurve

Parameters:: extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); inPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); asRatio - The asRatio (in); outPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); distanceAlongCurve - The distanceAlongCurve (in/out: use single element array); distanceFromCurve - The distanceFromCurve (in/out: use single element array); bRightSide - The bRightSide (in/out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPoint

queryTangent

public void queryTangent(int extension,
                         double distanceAlongCurve,
                         boolean asRatio,
                         double length,
                         ILine tangent)
                  throws IOException,
                         AutomationException

Constructs a line tangent to a curve from a point at a specified distance along the curve.

Description

Given a distance along the curve specified either as a ratio of the length or as a specific fixed distance, QueryTangent returns the Line tangent to the Point. The length and method of tangential extension of the tangent line are given by the user. The method of tangential extension determines the direction of the tangent line as though it were being extended at a From point or a To point.

Remarks

QueryTangent Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryTangent in interface ICurve

Parameters:: extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); distanceAlongCurve - The distanceAlongCurve (in); asRatio - The asRatio (in); length - The length (in); tangent - 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.
See Also:: ILine

queryNormal

public void queryNormal(int extension,
                        double distanceAlongCurve,
                        boolean asRatio,
                        double length,
                        ILine normal)
                 throws IOException,
                        AutomationException

Constructs a line normal to a curve from a point at a specified distance along the curve.

Description

Given a distance along the curve specified either as a ratio of the Length or as a specific fixed distance, QueryNormal returns the Line normal to the Point. The length and method of tangential extension of the normal line are given by the user. The method of tangential extension determines the direction of the normal line as though it were being extended at a From point or a To point.

Remarks

QueryNormal Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryNormal in interface ICurve

Parameters:: extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); distanceAlongCurve - The distanceAlongCurve (in); asRatio - The asRatio (in); length - The length (in); normal - 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.
See Also:: ILine

getSubcurve

public void getSubcurve(double fromDistance,
                        double toDistance,
                        boolean asRatio,
                        ICurve[] outSubcurve)
                 throws IOException,
                        AutomationException

Extracts a portion of this curve into a new curve.

Description

Gets the subcurve between the specified points along the original curve and creates a new curve. The elements in the new subcurve are the same type and have the same properties as the elements of the original curve. Which means if:

Input Geometry	Output Geometry
Polygon	Polyline
Polyline	Polyline
Ring	Path
Path	Path
Segment	Segment

If the input geometry is a polygon, you may want to use IRing::GetSubCurveEx which has more capabilities.

Remarks

Subcurve Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubcurve in interface ICurve

Parameters:: fromDistance - The fromDistance (in); toDistance - The toDistance (in); asRatio - The asRatio (in); outSubcurve - A reference to a com.esri.arcgis.geometry.ICurve (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IRing.getSubcurveEx(double, double, boolean, boolean, boolean), ICurve.getSubcurve(double, double, boolean, com.esri.arcgis.geometry.ICurve[])

reverseOrientation

public void reverseOrientation()
                        throws IOException,
                               AutomationException

Reverses the parameterization of the curve ('from' point becomes 'to' point, first segment becomes last segment, etc).

Description

ReverseOrientation changes the direction of the curve without changing the spatial position of the curve. The From Point and To Point of each Segment in each part of the curve are interchanged.

Remarks

The ReverseOrientation method works the same way as the Arcedit FLIP command. It reverses the order of the vertices in the Curve.

Caution should be taken in using ReverseOrientation on Polygons. Since ReverseOrientation changes the direction of each Ring within the Polygon, all Exterior Rings become Interior Rings and vice versa.

Reverse Orientation Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: reverseOrientation in interface ICurve

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

isClosed

public boolean isClosed()
                 throws IOException,
                        AutomationException

Indicates if 'from' and 'to' points (of each part) are identical.

Description

A curve is closed if the From and To points of each part of the curve are equal.

Remarks

IsClosed may still return TRUE if the curve consists of improperly constructed geometries (ex. non-continuous paths). IsClosed only checks the location of the From and To points of each part, it does not check the internal parts for topological consistency.

ICurve IsClosed Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isClosed in interface ICurve

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

generalize

public void generalize(double maxAllowableOffset)
                throws IOException,
                       AutomationException

Generalizes this path using the Douglas-Poiker algorithm.

Description

Generalizes the Path into a generalized collection of Line segments. Generalize performs a Douglas-Poiker Generalization algorithm with a specified maximum offset tolerance given as input. For Line segments, the Generalized output is a subset of the original input vertices. For non-Linear segments, the Generalized output contains points along all parts of the curve, not necessarily only the vertices.

Remarks

For a path with non-linear segments, the output curve may contain more vertices than the input curve, but all output segments will be linear.

IPath Generalize Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: generalize in interface IPath

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

smooth

public void smooth(double maxAllowableOffset)
            throws IOException,
                   AutomationException

Converts this path into a smooth approximation of itself that contains only Bezier curve segments.

Description

Converts the Path into a Path containing only BezierCurve segments. The created BezierCurve path is a Generalization of the original path that has a maximum deviation of maxDeviation from the original path. If maxDeviation = 0, all of the original vertices are maintained. At each vertex, the adjoining BezierCurves have complementary tangents which creates a continuous (smooth) transition between segments.

Remarks

IPath Smooth Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: smooth in interface IPath

Parameters:: maxAllowableOffset - The maxAllowableOffset (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPath.smooth(double), IPath.smoothLocal(int), IBezierCurve, IPolycurve.smooth(double)

smoothLocal

public void smoothLocal(int vertexIndex)
                 throws IOException,
                        AutomationException

Replaces up to four segments (two on each of the specified vertex index) with bezier curves.

Description

Converts segments containing the indexed vertex into BezierCurves and performs a smoothing operation only at the two segments on either side of the input vertex. The created BezierCurves have complementary tangents at the indexed vertex.

Remarks

IPath SmoothLocal Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: smoothLocal in interface IPath

Parameters:: vertexIndex - The vertexIndex (in)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPath.smooth(double), IPath.smoothLocal(int), IBezierCurve, IPolycurve.smooth(double)

queryChordLengthTangents

public void queryChordLengthTangents(int pointIndex,
                                     IPoint prevTangent,
                                     boolean[] prevSetByUser,
                                     IPoint nextTangent,
                                     boolean[] nextSetByUser)
                              throws IOException,
                                     AutomationException

Returns tangent vectors (relative to corresponding endpoint) at both sides of a Bezier end point; and whether they have been set by user or by smoothing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: queryChordLengthTangents in interface IPath

Parameters:: pointIndex - The pointIndex (in); prevTangent - A reference to a com.esri.arcgis.geometry.IPoint (in); prevSetByUser - The prevSetByUser (in/out: use single element array); nextTangent - A reference to a com.esri.arcgis.geometry.IPoint (in); nextSetByUser - The nextSetByUser (in/out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

setChordLengthTangents

public void setChordLengthTangents(int pointIndex,
                                   IPoint prevTangent,
                                   IPoint nextTangent)
                            throws IOException,
                                   AutomationException

Sets tangent vectors (relative to corresponding endpoint) at both sides of a Bezier end point; if either is Nothing, they will be set by smoothing process.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: setChordLengthTangents in interface IPath

Parameters:: pointIndex - The pointIndex (in); prevTangent - A reference to a com.esri.arcgis.geometry.IPoint (in); nextTangent - 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.

isExterior

public boolean isExterior()
                   throws IOException,
                          AutomationException

Indicates if this ring can function as the exterior ring in a polygon (ring orientation is clockwise, area > 0).

Description

IsExterior returns TRUE if the ring is oriented in a Clockwise direction. Exterior rings are always oriented clockwise, and interior rings are always oriented counterclockwise.

Remarks

Ring IsExterior Example

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: isExterior in interface IRing

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

reshape

public boolean reshape(IPath reshapeSource)
                throws IOException,
                       AutomationException

Modifies this ring by replacing some of its segments with some segments from reshapeSource.

Description

Reshape replaces the Segments in the Ring between consecutive Intersections with the input Path segments that connect those intersections. Reshape returns a boolean indicating whether or not a modification to the Ring occurred.

Remarks

To Reshape a Polygon, the Polygon must be Reshaped one Ring at a time.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: reshape in interface IRing

Parameters:: reshapeSource - A reference to a com.esri.arcgis.geometry.IPath (in)
Returns:: The reshapeHappened
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IPolyline.reshape(com.esri.arcgis.geometry.IPath), IRing.reshape(com.esri.arcgis.geometry.IPath)

close

public void close()
           throws IOException,
                  AutomationException

Makes sure that this ring is closed by adding a line segment between the ring's 'to' and 'from' points if necessary.

Description

Checks whether or not the From and To Points of the Path occur at the same Point. If the From and To Point have the same X and Y coordinates, the Ring is considered closed, and no action is taken. However, if the From and To Points are not at the same X and Y coordinates, a Line segment is added at the end of the Ring between the To Point and the From Point. This Line segment completes the Ring making it closed.

Remarks

This method should generally not be called in a 3D context, due to the fact that Close() only compares X and Y and not Z vertex values. Instead, the first point in the point collection should be manually re-added as the last point in the point collection to close the geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: close in interface IRing

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

getSubcurveEx

public ICurve getSubcurveEx(double fromDistance,
                            double toDistance,
                            boolean asRatio,
                            boolean isCCW,
                            boolean useRingOrientation)
                     throws IOException,
                            AutomationException

Extracts a portion of this curve into a new curve. The interior of the new curve may contain the from/to point of the ring when useRingOrientation is true.

Description

The GetSubCurveEx method creates a subcurve of a ring. The subcurve may include the ring origin. The result is always a path object which may be closed.

Remarks

Parameters description:

fromDistance: (Input) A double that represents the distance along the curve which will define one of the subcurve's endpoints. The value can be positive or negative.

toDistance: (Input) A double that represents the distance along the curve which will define the other endpoint of the subcurve. The value can be positive or negative.

If the fromDistance and toDistance values are equal, the output is a closed path with fromPoint and toPoint of the path at the specified distance. The orientation may be reversed, depending upon the other parameter settings.

asRatio: (Input) A boolean value that determines whether or not the input distances are interpreted as a ratio of the total length. If 'True', a fromDistance of 0 is at the beginning of the curve and a toDistance of 1 represents the end of the curve.

isCCW: (Input) A boolean expression that decides which of the two possible paths fromfromDistance to toDistance is chosen for output: counter-clockwise or not. This does not decide the orientation of the output path.

useRingOrientation: (Input) A boolean that determines whether the output path should follow the ring orientation or not. If bUseRingOrientation is true, the output subcurve must have the same orientation as the ring, even if it means that the subcurve starts at toDistance and ends at fromDistance. If bUseRingOrientation is false, the output subcurve always starts at fromDistance and ends at toDistance; it may have the opposite orientation as the original ring.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: getSubcurveEx in interface IRing

Parameters:: fromDistance - The fromDistance (in); toDistance - The toDistance (in); asRatio - The asRatio (in); isCCW - The isCCW (in); useRingOrientation - The useRingOrientation (in)
Returns:: A reference to a com.esri.arcgis.geometry.ICurve
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.
See Also:: IRing.getSubcurveEx(double, double, boolean, boolean, boolean), ICurve.getSubcurve(double, double, boolean, com.esri.arcgis.geometry.ICurve[])

reshapeEx

public void reshapeEx(IPath reshapeSource,
                      IGeometry[] leftResult,
                      IGeometry[] rightResult)
               throws IOException,
                      AutomationException

Creates two new polygons by using segments from the ring and from reshapeSource.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: reshapeEx in interface IRing2

Parameters:: reshapeSource - A reference to a com.esri.arcgis.geometry.IPath (in); leftResult - A reference to a com.esri.arcgis.geometry.IGeometry (out: use single element array); rightResult - 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.

constructRigidStretch

public void constructRigidStretch(IPath srcPath,
                                  int stretchStartIndex,
                                  int startAnchor,
                                  int endAnchor,
                                  IPoint stretchEnd)
                           throws IOException,
                                  AutomationException

Constructs a scaled, rotated version of srcPath. The point at stretchStartIndex will end up at stretchEnd. The points at startAnchor and endAnchor will remain unchanged. Others will be scaled and rotate proportionately.

Description

For an existing Path, the ConstructRigidStretch method can be used to rotate and scale the shape of a Path, or just a section of the Path, to a certain point. This method is ideal for use in interactive rubber-sheeting operations. ArcMap, for example, makes use of this method in the �Stretch geometry proportionally when moving a vertex� option.

Remarks

Parameters description:

srcPath: Input IPath object. The path to be stretched.
stretchStartIndex: Input Long that represents the index of the origin point on the path to be stretched.
startAnchor: Input Long that represents the start anchor. Typically 0 to represent the first point on the path.
endAnchor: Input Long that represents the end anchor. Typically pointcount-1 to represent the last point on the path.
stretchEnd: Input IPoint object. The destination point where the strecthStartIndex point will be moved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:: constructRigidStretch in interface IConstructPath

Parameters:: srcPath - A reference to a com.esri.arcgis.geometry.IPath (in); stretchStartIndex - The stretchStartIndex (in); startAnchor - The startAnchor (in); endAnchor - The endAnchor (in); stretchEnd - 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.

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.

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.

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.

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.

getLength3D

public double getLength3D()
                   throws IOException,
                          AutomationException

The length of the curve.

Description

Returns the 3D length of the entire curve. The length of the curve is the sum of the lengths along each parameterized Segment between vertices along the curve.

Product Availability

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

Specified by:: getLength3D in interface ICurve3D

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

queryPoint3D

public void queryPoint3D(int extension,
                         double distanceAlongCurve,
                         boolean bAsRatio,
                         IPoint pOutPoint)
                  throws IOException,
                         AutomationException

Copies to outPoint the properties of a point on the curve at a specified distance from the beginning of the curve.

Description

Returns the Point at a given 3D distance along the curve or extended curve. If the distance is less than the length of the curve, then the returned point is the point at that distance along the curve. If the distance is less than zero, or greater than the length of the curve, then the returned point is on the curve specified by the extension method. The distance may be specified as a fixed unit of measure or a ratio of the 3D length of the curve.

Product Availability

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

Specified by:: queryPoint3D in interface ICurve3D

Parameters:: extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); distanceAlongCurve - The distanceAlongCurve (in); bAsRatio - The bAsRatio (in); pOutPoint - 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.

getSubcurve3D

public void getSubcurve3D(double fromDistance,
                          double toDistance,
                          boolean bAsRatio,
                          ICurve3D[] ppOutSubCurve)
                   throws IOException,
                          AutomationException

Extracts a portion of this curve into a new curve.

Description

Product Availability

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

Specified by:: getSubcurve3D in interface ICurve3D

Parameters:: fromDistance - The fromDistance (in); toDistance - The toDistance (in); bAsRatio - The bAsRatio (in); ppOutSubCurve - A reference to a com.esri.arcgis.geometry.ICurve3D (out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

queryPointAndDistance3D

public void queryPointAndDistance3D(int extension,
                                    IPoint pInPoint,
                                    boolean bAsRatio,
                                    IPoint pOutPoint,
                                    double[] pDistanceAlongCurve,
                                    double[] pDistanceFromCurve)
                             throws IOException,
                                    AutomationException

Finds the point on the curve closest to inPoint, then copies that point to outPoint; optionally calculates related items.

Description

Product Availability

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

Specified by:: queryPointAndDistance3D in interface ICurve3D

Parameters:: extension - A com.esri.arcgis.geometry.esriSegmentExtension constant (in); pInPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); bAsRatio - The bAsRatio (in); pOutPoint - A reference to a com.esri.arcgis.geometry.IPoint (in); pDistanceAlongCurve - The pDistanceAlongCurve (in/out: use single element array); pDistanceFromCurve - The pDistanceFromCurve (in/out: use single element array)
Throws:: IOException - If there are interop problems.; AutomationException - If the ArcObject component throws an exception.

isClosed3D

public boolean isClosed3D()
                   throws IOException,
                          AutomationException

Indicates if 'from' and 'to' points (of each part) are identical.

Product Availability

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

Specified by:: isClosed3D in interface ICurve3D

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

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.esri.arcgis.geometry Class Ring

Product Availability

Supported Platforms

Ring

Ring

getClsid

equals

hashCode

getPointCount

Description

Product Availability

Supported Platforms

getPoint

Product Availability

addPoint

Description

Product Availability

Supported Platforms

updatePoint

Description

Remarks

Example:

Product Availability

Supported Platforms

queryPoints

Description

Product Availability

Supported Platforms

insertPoints

Description

Product Availability

Supported Platforms

insertPointCollection

Description

Product Availability

Supported Platforms

addPoints

Description

Product Availability

Supported Platforms

addPointCollection

Description

Product Availability

Supported Platforms

setPoints

Description

Product Availability

Supported Platforms

setPointCollection

Description

Product Availability

Supported Platforms

removePoints

Description

Product Availability

Supported Platforms

getEnumVertices

Description

Product Availability

Supported Platforms

replacePoints

Description

Product Availability

Supported Platforms

replacePointCollection

Description

Product Availability

Supported Platforms

queryPoint

Description

Remarks

Product Availability

Supported Platforms

addWKSPointZs

Product Availability

Supported Platforms

setWKSPointZs

Product Availability

Supported Platforms

queryWKSPointZs

com.esri.arcgis.geometry
Class Ring