com.esri.arcgis.geometry
Interface IEnumPointAndDistance

All Superinterfaces:
IEnumVertex, Serializable
All Known Implementing Classes:
IEnumPointAndDistanceProxy

public interface IEnumPointAndDistance
extends IEnumVertex, Serializable

Provides access to members that iterate over the points on a geometry that are closest to an input point, as returned by QueryPointsAndDistances.

Description

The IEnumPointAndDistance enumerator is used with the ICurve3::QueryPointsAndDistances method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 double getDistanceAlongCurve()
          Gives the distance along the curve from the curve's from point to the current postion.
 boolean isContinuousSectionAfter()
          Indicates whether the current point and the next point lie on a circular arc with the query point at its center.
 boolean isContinuousSectionBefore()
          Indicates whether the current point and the previous point lie on a circular arc with the query point at its center.
 boolean isOnRightSide()
          Indicates whether the query point is to the right of the curve at the current position.
 
Methods inherited from interface com.esri.arcgis.geometry.IEnumVertex
esri_clone, isLastInPart, next, nextInPart, previous, put_ID, put_M, put_X, put_Y, put_Z, queryNext, queryNextInPart, queryPrevious, reset, resetToEnd, setAt, skip
 

Method Detail

isContinuousSectionBefore

boolean isContinuousSectionBefore()
                                  throws IOException,
                                         AutomationException
Indicates whether the current point and the previous point lie on a circular arc with the query point at its center.

Description

The ContinuousSectionAfter and ContinuousSectionBefore indicate if two subsequent points in the enumerator are lying on a Circular Arc.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isContinuousSectionAfter

boolean isContinuousSectionAfter()
                                 throws IOException,
                                        AutomationException
Indicates whether the current point and the next point lie on a circular arc with the query point at its center.

Description

The ContinuousSectionAfter and ContinuousSectionBefore indicate if two subsequent points in the enumerator are lying on a Circular Arc.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isOnRightSide

boolean isOnRightSide()
                      throws IOException,
                             AutomationException
Indicates whether the query point is to the right of the curve at the current position.

Description

OnRightSide indicates if the current point is on the right side of the curve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDistanceAlongCurve

double getDistanceAlongCurve()
                             throws IOException,
                                    AutomationException
Gives the distance along the curve from the curve's from point to the current postion.

Description

DistanceAlongCurve indicates the distance between the fromPoint and the current point on the enumerator. That distance can be either a real distance or a ratio varying between 0 and 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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