Class Edge
A unique edge in a cell complex, regardless of directionality when it comes to face traversal. Directional edges for this purpose are in associated DirectedEdges. There is a maximum of two DirectedEdges per Edge.
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Elements.Spatial.CellComplex
Assembly: Hypar.Elements.dll
Syntax
public class Edge : EdgeBase<Edge>, IDistanceTo, IHasNeighbors<Edge, Line>Methods
GetCells()
Get associated Cells
Declaration
public List<Cell> GetCells()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<Cell> |
GetClosestCell(Vector3)
Get the associated Cell that is closest to a point.
Declaration
public Cell GetClosestCell(Vector3 point)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | point |
Returns
| Type | Description |
|---|---|
| Cell |
GetClosestFace(Vector3)
Get the associated Face that is closest to a point.
Declaration
public Face GetClosestFace(Vector3 point)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | point |
Returns
| Type | Description |
|---|---|
| Face |
GetClosestNeighbor(Vector3)
Get the closest neighboring Edge to a point.
Declaration
public Edge GetClosestNeighbor(Vector3 target)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | target |
Returns
| Type | Description |
|---|---|
| Edge |
GetClosestVertex(Vector3)
Get the associated Vertex that is closest to a point.
Declaration
public Vertex GetClosestVertex(Vector3 point)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | point |
Returns
| Type | Description |
|---|---|
| Vertex |
GetFaces()
Get associated Faces.
Declaration
public List<Face> GetFaces()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<Face> |
GetNeighbors()
Get a list of all neighboring Edges that share a Vertex.
Declaration
public List<Edge> GetNeighbors()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<Edge> |
GetVertices()
Get associated Vertices.
Declaration
public List<Vertex> GetVertices()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<Vertex> |
TraverseNeighbors(Vector3, Double)
Traverse the neighbors of this Edge toward the target point.
Declaration
public List<Edge> TraverseNeighbors(Vector3 target, double completedRadius = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | target | |
| System.Double | completedRadius | If provided, ends the traversal when the neighbor is within this distance to the target point. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<Edge> | A collection of traversed Edges, including the starting Edge. |