## VertexCollection.NeighborVertices

### Introduced

v3.0

### Description

Returns a collection of Vertex objects for all vertex neighbors within the specified distance.

### C# Syntax

    VertexCollection VertexCollection.NeighborVertices( Int32 in_lDistance );

### Scripting Syntax

    oReturn = VertexCollection.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

    set oPolygons = oGeometry.Polygons

    set oNeighborVertices = oPolygons(0).NeighborVertices

    set oNeighbors = oNeighborVertices.NeighborVertices

    str = "Vertexs neighbors of this VertexCollection are :"

    for each n in oNeighbors

    str = str & " " & n.index

    next

    logmessage str

### See Also

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