| java.lang.Object | |
| ↳ | com.esri.core.geometry.SegmentIterator |
Class Overview
This class provides functionality to iterate over multipath segments.
Summary
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Object |
copy()
Copies this SegmentIterator.
| ||||||||||
| int |
getEndPointIndex()
Returns the index of the end point of the current segment.
| ||||||||||
| int |
getPathIndex()
Returns the index of the current path.
| ||||||||||
| int |
getStartPointIndex()
Returns the index of the start point of this segment.
| ||||||||||
| boolean |
hasNextSegment()
Indicates whether a next segment exists for the path.
| ||||||||||
| boolean |
hasPreviousSegment()
Indicates whether a previous segment exists in the path.
| ||||||||||
| boolean |
isClosingSegment()
Returns TRUE, if the segment is the closing segment of the closed path
| ||||||||||
| boolean |
isFirstSegmentInPath()
Indicates whether the iterator points to the first segment in the current path.
| ||||||||||
| boolean |
isLastSegmentInPath()
Indicates whether the iterator points to the last segment in the current path.
| ||||||||||
| boolean |
nextPath()
Moves the iterator to the next path.
| ||||||||||
| Segment |
nextSegment()
Moves the iterator to the next segment and returns the segment.
| ||||||||||
| boolean |
previousPath()
Moves the iterator to the previous path.
| ||||||||||
| Segment |
previousSegment()
Moves the iterator to previous segment and returns the segment.
| ||||||||||
| void |
resetToFirstPath()
Resets the iterator such that a subsequent call to NextPath will set the iterator to the first path.
| ||||||||||
| void |
resetToFirstSegment()
Resets the iterator so that the call to NextSegment will return the first segment of the current path.
| ||||||||||
| void |
resetToLastPath()
Resets the iterator such that a subsequent call to PreviousPath will set the iterator to the last path.
| ||||||||||
| void |
resetToLastSegment()
Resets the iterator so that the call to PreviousSegment will return the last segment of the current path.
| ||||||||||
| void |
resetToPath(int pathIndex)
Resets the iterator such that a subsequent call to NextPath will set the iterator to the given path index.
| ||||||||||
| void |
setCirculator(boolean bYesNo)
Switches the iterator to navigation mode.
| ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Object | _getImpl() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public int getEndPointIndex ()
Returns the index of the end point of the current segment.
public int getPathIndex ()
Returns the index of the current path.
public int getStartPointIndex ()
Returns the index of the start point of this segment.
public boolean hasNextSegment ()
Indicates whether a next segment exists for the path.
Returns
- TRUE is the next segment exists.
public boolean hasPreviousSegment ()
Indicates whether a previous segment exists in the path.
Returns
- TRUE if the previous segment exists.
public boolean isClosingSegment ()
Returns TRUE, if the segment is the closing segment of the closed path
public boolean isFirstSegmentInPath ()
Indicates whether the iterator points to the first segment in the current path.
Returns
- TRUE if the iterator points to the first segment in the current path.
public boolean isLastSegmentInPath ()
Indicates whether the iterator points to the last segment in the current path.
Returns
- TRUE if the iterator points to the last segment in the current path.
public boolean nextPath ()
Moves the iterator to the next path. Returns the TRUE if successful.
Returns
- TRUE if the next path exists.
public Segment nextSegment ()
Moves the iterator to the next segment and returns the segment. The Segment is returned by value and is owned by the iterator.
public boolean previousPath ()
Moves the iterator to the previous path. Returns the TRUE if successful.
Returns
- TRUE if the previous path exists.
public Segment previousSegment ()
Moves the iterator to previous segment and returns the segment. The Segment is returned by value and is owned by the iterator.
public void resetToFirstPath ()
Resets the iterator such that a subsequent call to NextPath will set the iterator to the first path.
public void resetToFirstSegment ()
Resets the iterator so that the call to NextSegment will return the first segment of the current path.
public void resetToLastPath ()
Resets the iterator such that a subsequent call to PreviousPath will set the iterator to the last path.
public void resetToLastSegment ()
Resets the iterator so that the call to PreviousSegment will return the last segment of the current path.
public void resetToPath (int pathIndex)
Resets the iterator such that a subsequent call to NextPath will set the iterator to the given path index. A call to PreviousPath will set the iterator to the path at pathIndex - 1.
public void setCirculator (boolean bYesNo)
Switches the iterator to navigation mode.
Parameters
| bYesNo | If TRUE, the iterator loops over the current path infinitely (unless the multipath is empty). |
|---|