Interface IEnumSegment

Namespace
ESRI.ArcGIS.Geometry
Assembly
ESRI.Server.Geometry.dll

Provides access to members that iterate over collections of segments (obtained from the EnumSegments property on the ISegmentCollection interface).

[Guid("C63FAF0E-1040-11D1-A27D-0000F8775FBF")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface IEnumSegment

Properties

IsRecycling

Indicates if this enumerator re-uses the same segment each time next is called.

bool IsRecycling { get; }

Property Value

bool

Remarks

Note: The IsRecycling state is contolled by the system and cannot be directly changed by users.

Methods

Clone(out IEnumSegment)

Returns a copy of this enumerator positioned at the same segment.

void Clone(out IEnumSegment outEnumerator)

Parameters

outEnumerator IEnumSegment

IsLastInPart()

Indicates if the current segment is last in the current part.

bool IsLastInPart()

Returns

bool

Next(out ISegment, ref int, ref int)

Returns the next segment, and its location in the collection. If the location does not have parts (i.e. a path or ring) then the part index will always be zero.

void Next(out ISegment outSegment, ref int outPartIndex, ref int SegmentIndex)

Parameters

outSegment ISegment
outPartIndex int
SegmentIndex int

Remarks

See picture for a graphical explanation of some of the IEnumSegment methods.

NextEx(out esriSegmentInfo)

Populates a segment info structure with information on the next segment in the collection.

void NextEx(out esriSegmentInfo outSegment)

Parameters

outSegment esriSegmentInfo

NextInPart(out ISegment, ref int)

Returns the next segment in current part, goes back to first segment after last segment in part is encountered.

void NextInPart(out ISegment outSegment, ref int OutSegmentIndex)

Parameters

outSegment ISegment
OutSegmentIndex int

NextInPartEx(out esriSegmentInfo)

Returns the next segment info structure in current part, goes back to first segment after last segment in part is encountered.

void NextInPartEx(out esriSegmentInfo outSegment)

Parameters

outSegment esriSegmentInfo

Previous(out ISegment, ref int, ref int)

Returns the previous segment in this segment collection.

void Previous(out ISegment outSegment, ref int outPartIndex, ref int SegmentIndex)

Parameters

outSegment ISegment
outPartIndex int
SegmentIndex int

Remarks

See picture for a graphical explanation of some of the IEnumSegment methods.

Reset()

Starts from the beginning of the segment collection the next time Next is called.

void Reset()

Remarks

See picture for a graphical explanation of some of the IEnumSegment methods.

ResetToEnd()

Starts from the end of the path, ring, polyline or polygon the next time Previous is called.

void ResetToEnd()

Remarks

See picture for a graphical explanation of some of the IEnumSegment methods.

SetAt(int, int)

Resets enumerator to specific location.

void SetAt(int iPart, int ISegment)

Parameters

iPart int
ISegment int

Remarks

See picture for a graphical explanation of some of the IEnumSegment methods.

Skip(int)

Skips forward or backward over a specified number of segments.

void Skip(int numSegments)

Parameters

numSegments int