Interface IEnumVertex

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

Provides access to members that iterate over the vertices or points of a geometry (see the EnumVertices property of the IPointCollection interface).

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("4CF93638-EB81-11D2-9F2D-00C04F6BC8E8")]
public interface IEnumVertex

Methods

Clone()

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

IEnumVertex Clone()

Returns

IEnumVertex

IsLastInPart()

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

bool IsLastInPart()

Returns

bool

Next(out IPoint, out int, out int)

Returns the next vertex and its location within the geometry.

void Next(out IPoint outVertex, out int outPartIndex, out int vertexIndex)

Parameters

outVertex IPoint
outPartIndex int
vertexIndex int

Remarks

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

NextInPart(out IPoint, out int)

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

void NextInPart(out IPoint outVertex, out int OutVertexIndex)

Parameters

outVertex IPoint
OutVertexIndex int

Previous(out IPoint, out int, out int)

Returns the previous vertex and its location in the geometry.

void Previous(out IPoint outVertex, out int outPartIndex, out int vertexIndex)

Parameters

outVertex IPoint
outPartIndex int
vertexIndex int

Remarks

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

QueryNext(IPoint, out int, out int)

Copies the next vertex to the input parameter and returns its location in the geometry.

void QueryNext(IPoint vertex, out int outPartIndex, out int vertexIndex)

Parameters

vertex IPoint
outPartIndex int
vertexIndex int

Remarks

Note: The output point must be co-created prior to use the query. The output point 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 inside the loop could improve performance compare to calling Next method which needs to co-create point each time.

QueryNextInPart(IPoint, out int)

Copies the next vertex in the current part to the input parameter and returns its location in current part. Continues with the first vertex in the part if already at the end.

void QueryNextInPart(IPoint vertex, out int OutVertexIndex)

Parameters

vertex IPoint
OutVertexIndex int

Remarks

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.

QueryPrevious(IPoint, out int, out int)

Copies the previous vertex to the input parameter and returns its location in the geometry.

void QueryPrevious(IPoint vertex, out int outPartIndex, out int vertexIndex)

Parameters

vertex IPoint
outPartIndex int
vertexIndex int

Remarks

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.

Reset()

Starts from the beginning of the geometry the next time Next is called.

void Reset()

Remarks

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

ResetToEnd()

Starts from the end of the geometry the next time Previous is called.

void ResetToEnd()

Remarks

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

SetAt(int, int)

Resets enumerator to specific location.

void SetAt(int iPart, int iVertex)

Parameters

iPart int
iVertex int

Remarks

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

Skip(int)

Skips forward or backward over a specified number of vertices.

void Skip(int numVertices)

Parameters

numVertices int

put_Attribute(esriGeometryAttributes, double)

Sets attribute values at the current vertex.

void put_Attribute(esriGeometryAttributes attributeType, double Value)

Parameters

attributeType esriGeometryAttributes
Value double

put_ID(int)

Sets the ID attribute of the current vertex. For segment-based geometries, this will modify a pair of segments.

void put_ID(int pointID)

Parameters

pointID int

put_M(double)

Sets the M attribute of the current vertex. For segment-based geometries, this will modify a pair of segments.

void put_M(double M)

Parameters

M double

put_X(double)

Sets the X coordinate of the current vertex. For segment-based geometries, this will modify a pair of segments.

void put_X(double X)

Parameters

X double

put_Y(double)

Sets the Y coordinate of the current vertex. For segment-based geometries, this will modify a pair of segments.

void put_Y(double Y)

Parameters

Y double

put_Z(double)

Sets the Z coordinate of the current vertex. For segment-based geometries, this will modify a pair of segments.

void put_Z(double Z)

Parameters

Z double