com.esri.arcgis.geometry
Interface IEnumSplitPoint

All Superinterfaces:

IEnumVertex, Serializable

All Known Implementing Classes:

IEnumSplitPointProxy

public interface IEnumSplitPoint
extends IEnumVertex, Serializable

Provides access to members that iterate over the new vertices in a geometry introduced as a result of using SplitAtPoints/SplitAtDistances.

Description

The IEnumSplitPoint is used by the IPolycurve2::SplitAtPoints and the IPolycurve2::SplitAtDistances methods.

Product Availability

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

Method Summary

int	getOldID() The original PointID value at the split location before the split happened.
double	getOldM() The original M value at the current split location before the split happened.
double	getOldZ() The original Z value at the current split location before the split happened.
double	getSplitDistance() The distance of the current split vertex from the beginning of the polycurve.
boolean	isSplitHappened() Indicates whether or not a split was performed at the current vertex (a split point could be the same as a vertex existing before SplitAtPoints/Distances was used).
void	nextInSequence(IPoint[] splitPoint, int[] part, int[] vertex) Returns the next split point along with its location in the geometry.
void	previousInSequence(IPoint[] splitPoint, int[] part, int[] vertex) Returns the previous split point along with its location in the geometry.

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

nextInSequence

void nextInSequence(IPoint[] splitPoint,
                    int[] part,
                    int[] vertex)
                    throws IOException,
                           AutomationException

Returns the next split point along with its location in the geometry.

Description

The NextInSequence method returns an IPoint object along with its part index and its vertex index. The points returned by that method are the input splitPoints if the IEnumSplitPoint was created using the IPolycurve2::SplitAtPoints method or they are points located on the split curve if the IPolycurve2::SplitAtDistances method was used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

splitPoint - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)

part - The part (in/out: use single element array)

vertex - The vertex (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

previousInSequence

void previousInSequence(IPoint[] splitPoint,
                        int[] part,
                        int[] vertex)
                        throws IOException,
                               AutomationException

Returns the previous split point along with its location in the geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

splitPoint - A reference to a com.esri.arcgis.geometry.IPoint (out: use single element array)

part - The part (in/out: use single element array)

vertex - The vertex (in/out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSplitHappened

boolean isSplitHappened()
                        throws IOException,
                               AutomationException

Indicates whether or not a split was performed at the current vertex (a split point could be the same as a vertex existing before SplitAtPoints/Distances was used).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The splitHappened

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSplitDistance

double getSplitDistance()
                        throws IOException,
                               AutomationException

The distance of the current split vertex from the beginning of the polycurve.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The splitDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOldM

double getOldM()
               throws IOException,
                      AutomationException

The original M value at the current split location before the split happened.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The oldM

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOldZ

double getOldZ()
               throws IOException,
                      AutomationException

The original Z value at the current split location before the split happened.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The oldZ

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOldID

int getOldID()
             throws IOException,
                    AutomationException

The original PointID value at the split location before the split happened.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The oldID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.