com.esri.arcgis.geometry
Interface IEnumCurve2

All Superinterfaces:
IEnumCurve, Serializable
All Known Implementing Classes:
IEnumCurve2Proxy

public interface IEnumCurve2
extends IEnumCurve, Serializable

Provides access to members that extend IEnumCurve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void queryPoint(double fromDistance, boolean asRatio, IPoint pointOnCurve)
          Copies a location on this curve into pointOnCurve.
 void querySubcurve(double fromDistance, double toDistance, boolean asRatio, ICurve subcurve)
          Copies a portion of this curve into an existing subcurve.
 
Methods inherited from interface com.esri.arcgis.geometry.IEnumCurve
esri_clone, getCurveDistance, getPartIndex, getSegment, getSegmentDistance, getSegmentIndex, getStopOptions, getStopReason, getSubcurve, next, reset, setStopOptions
 

Method Detail

querySubcurve

void querySubcurve(double fromDistance,
                   double toDistance,
                   boolean asRatio,
                   ICurve subcurve)
                   throws IOException,
                          AutomationException
Copies a portion of this curve into an existing subcurve. AsRatio is true when fromDistance and toDistance are normalized to the interval [0..1].

Description

The QuerySubCurve method returns a polyline object corresponding to a portion of the input curve.

Remarks

Note: Gaps between parts are ignored in distance computations.

Parameters description:

fromDistance: Input Double. Input distance that determines where the subcurve should start. The value of that parameter should be in map unit unless asRatio is true.
toDistance: Input Double. Input distance that determines where the subcurve should stop. The value of that parameter should be in map unit unless asRatio is true.
asRatio: Input Boolean. The asRatio determines if the input distances should be interpreted as map unit asRatio = false distance or parametric distance asRatio = True (0 = distance of 0, 1 = full length of the curve).

subcurve: Output polyline object. It contains the output subcurve.

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

Parameters:
fromDistance - The fromDistance (in)
toDistance - The toDistance (in)
asRatio - The asRatio (in)
subcurve - A reference to a com.esri.arcgis.geometry.ICurve (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryPoint

void queryPoint(double fromDistance,
                boolean asRatio,
                IPoint pointOnCurve)
                throws IOException,
                       AutomationException
Copies a location on this curve into pointOnCurve. AsRatio is true when fromDistance is normalized to the interval [0..1].

Description

The QueryPoint method returns a point object located on the input curve at the fromDistance calculated along the curve. This method can be used to quickly retrieve a large sequence of evenly or unevenly spaced points along a curve. This could be used to place symbols along a curve, for example railroads.

Remarks

Note: Gaps between parts are ignored in distance computations.

Parameters description:

fromDistance: Input Double. Input distance that determines where along the point should be created. The value of that parameter should be in map unit unless asRatio is true.
asRatio: Input Boolean. The asRatio determines if the input distances should be interpreted as map unit asRatio = false distance or parametric distance asRatio = True (0 = distance of 0, 1 = full length of the curve).

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

Parameters:
fromDistance - The fromDistance (in)
asRatio - The asRatio (in)
pointOnCurve - 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.