Class Cell

A cell is a 3-dimensional closed extrusion within a complex.

Inheritance

System.Object

ChildBase<Cell, Extrude>

Cell

Implements

IDistanceTo

IHasNeighbors<Cell, Extrude>

Inherited Members

ChildBase<Cell, Extrude>.Id

ChildBase<Cell, Extrude>.CellComplex

ChildBase<Cell, Extrude>.GetHashCode()

ChildBase<Cell, Extrude>.DistanceTo(Vector3)

ChildBase<Cell, Extrude>.Equals(Object)

ChildBase<Cell, Extrude>.GetGeometry()

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 Cell : ChildBase<Cell, Extrude>, IDistanceTo, IHasNeighbors<Cell, Extrude>

Fields

BottomFaceId

The ID of this cell's bottom face. If set, it is also expected to be duplicated in list of faces. In the current implementation of CellComplex, this should always be set. This may not be the case in the future, if Cells are no longer constrained to vertical extrusions.

Declaration

public ulong? BottomFaceId

Field Value

Type	Description
System.Nullable<System.UInt64>

FaceIds

The IDs of all the faces which belong to this Cell.

Declaration

public List<ulong> FaceIds

Field Value

Type	Description
System.Collections.Generic.List<System.UInt64>

TopFaceId

The ID of this cell's top face. If set, it is also expected to be duplicated in list of faces. In the current implementation of CellComplex, this should always be set. This may not be the case in the future, if Cells are no longer constrained to vertical extrusions.

Declaration

public ulong? TopFaceId

Field Value

Type	Description
System.Nullable<System.UInt64>

Methods

DistanceTo(Vector3)

Get the shortest distance from a point to the geometry representing this cell.

Declaration

public override double DistanceTo(Vector3 point)

Parameters

Type	Name	Description
Vector3	point

Returns

Type	Description
System.Double

Overrides

Elements.Spatial.CellComplex.ChildBase<Elements.Spatial.CellComplex.Cell, Elements.Geometry.Solids.Extrude>.DistanceTo(Elements.Geometry.Vector3)

GetBottomFace()

Get bottom face, if defined.

Declaration

public Face GetBottomFace()

Returns

Type	Description
Face

GetClosestEdge(Vector3)

Get the associated Edge that is closest to a point.

Declaration

public Edge GetClosestEdge(Vector3 point)

Parameters

Type	Name	Description
Vector3	point

Returns

Type	Description
Edge

GetClosestFace(Vector3)

Get the closest associated face to the supplied position.

Declaration

public Face GetClosestFace(Vector3 point)

Parameters

Type	Name	Description
Vector3	point

Returns

Type	Description
Face

GetClosestNeighbor(Vector3)

Get the closest associated cell to the supplied point.

Declaration

public Cell GetClosestNeighbor(Vector3 target)

Parameters

Type	Name	Description
Vector3	target

Returns

Type	Description
Cell

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

GetEdges()

Get associated Edges.

Declaration

public List<Edge> GetEdges()

Returns

Type	Description
System.Collections.Generic.List<Edge>

GetFaces()

Get associated Faces.

Declaration

public List<Face> GetFaces()

Returns

Type	Description
System.Collections.Generic.List<Face>

GetGeometry()

Get a Solid Extrusion representing this Cell.

Declaration

public override Extrude GetGeometry()

Returns

Type	Description
Extrude

Overrides

Elements.Spatial.CellComplex.ChildBase<Elements.Spatial.CellComplex.Cell, Elements.Geometry.Solids.Extrude>.GetGeometry()

GetNeighbors()

Get list of Cells that are neighbors.

Declaration

public List<Cell> GetNeighbors()

Returns

Type	Description
System.Collections.Generic.List<Cell>

GetNeighbors(Face)

Get the neighbor that shares a specific Face with this cell. Can be null if the face is not shared.

Declaration

public Cell GetNeighbors(Face face)

Parameters

Type	Name	Description
Face	face	Shared face

Returns

Type	Description
Cell

GetTopFace()

Get top face, if defined.

Declaration

public Face GetTopFace()

Returns

Type	Description
Face

GetVertices(Nullable<Vector3>)

Get associated Vertices.

Declaration

public List<Vertex> GetVertices(Vector3? point = null)

Parameters

Type	Name	Description
System.Nullable<Vector3>	point

Returns

Type	Description
System.Collections.Generic.List<Vertex>

TraverseNeighbors(Vector3, Double)

Traverse the neighbors of this Cell toward the target point.

Declaration

public List<Cell> 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<Cell>	A collection of traversed Cells, including the starting Cell.

Implements

IDistanceTo

IHasNeighbors<ChildClass, GeometryType>