API Reference › core-geometry› Polyface › SortableEdge

SortableEdge Class

Represent an IndexedPolyface edge as:

  • vertex start index and vertex end index (CCW order around its facet)
  • an additional number to associate with the edge (e.g., facet index)

Methods

Name Description
constructor(startVertex: number, endVertex: number, facetIndex: number): SortableEdge Constructor.  
clone(): SortableEdge Clone the edge.  
toJSON(): any Return the edge data as a JSON array.  
areDirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean Static Return true if edgeA and edgeB traverse the same edge in opposite directions.  
areUndirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean Static Return true if edgeA and edgeB traverse the same edge in the same or opposite directions.  
clusterArrayToJSON(data: SortableEdgeCluster[]): any[] Static Return the edge cluster array in JSON format.  
clusterToJSON(data: SortableEdgeCluster): any Static Return the edge cluster in JSON format.  
lessThan(edgeA: SortableEdge, edgeB: SortableEdge): number Static Lexical comparison of two edges.  
relativeOrientation(edgeA: SortableEdge, edgeB: SortableEdge): number Static Return numeric identifier for the relationship between edgeA and edgeB:  

Properties

Name Type Description
endVertex Accessor ReadOnly number Return the vertex index that appears second in the order stored.  
facetIndex Accessor ReadOnly number Return the facet index.  
highVertex Accessor ReadOnly number Return the vertex index with higher numeric value.  
isLowHigh Accessor ReadOnly boolean return true if startVertex is less than endVertex.  
isNullEdge Accessor ReadOnly boolean Whether the start and end vertex indices are equal.  
lowVertex Accessor ReadOnly number Return the vertex index with lower numeric value.  
startVertex Accessor ReadOnly number Return the vertex index that appears first in the order stored.  

Defined in

Last Updated: 27 June, 2025