## Vertex.NeighborVertices

### Introduced

v3.0

### Description

Returns a collection of Vertex objects for all vertex neighbors within the specified distance. If the distance is 1 the Vertex are returned in counter-clockwise order.

### C# Syntax

    VertexCollection Vertex.NeighborVertices( Int32 in_lDistance );

### Scripting Syntax

    oReturn = Vertex.NeighborVertices( [Distance] );

### Return Value

VertexCollection

### Parameters

Parameter | Type | Description
--- | --- | ---
Distance | Integer | Distance is an integer value representing the degree of neighborhood (eg: degree=2 for a vertex means its adjacent vertices plus the adjacent vertices of the adjacent vertices). Default Value: 1

### Examples

#### VBScript Example

    set oCube = ActiveSceneRoot.AddGeometry( "Cube", "MeshSurface" )

    set oGeometry = oCube.ActivePrimitive.Geometry

    for each Vertex in oGeometry.Vertices

    set oNeighbors = Vertex.NeighborVertices

    str = "Vertices neighbors of Vertex(" & Vertex.index & ") are :"

    for each n in oNeighbors

    str = str & " " & n.index

    next

    logmessage str

    next

### See Also

VertexCollection.NeighborVertices Vertex.NeighborEdges Vertex.NeighborPolygons Vertex.GrowNeighborVertices