API Reference > core-geometry > Polyface > SortableEdge

SortableEdge Class

  • For boundary sorting, an edge is a (packed!) Float64Array.
  • Fixed entry positions are:
    • [0] is start vertex index (in CCW order around its facet)
    • [1] is end vertex index (in CCW order around its facet)
    • [2] is facet index.

Extends

  • Float64Array

Methods

Name Description
constructor(vertexA: number, vertexB: number, facetIndex: number): SortableEdge    
toJSON(): any    
areDirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean Static Return true if the vertices edgeA and edgeB are the same vertex indices in opposite order  
areUndirectedPartners(edgeA: SortableEdge, edgeB: SortableEdge): boolean Static Return true if the vertices edgeA and edgeB are the same vertex indices with no consideration of order  
clusterArrayToJSON(data: SortableEdgeCluster[]): any[] Static    
clusterToJSON(data: SortableEdgeCluster): any Static    
lessThan(edgeA: SortableEdge, edgeB: SortableEdge): number Static lexical comparison of two edges.  
relativeOrientation(edgeA: SortableEdge, edgeB: SortableEdge): number Static Return numeric relationship of edgeA and edgeB:  

Properties

Name Type Description
facetIndex Accessor ReadOnly number Return the facet index.  
highVertexIndex Accessor ReadOnly number Return the vertex index with higher numeric value  
isLowHigh Accessor ReadOnly boolean return true if vertexIndexA is less than vertexIndexB  
isNullEdge Accessor ReadOnly boolean    
lowVertexIndex Accessor ReadOnly number Return the vertex index with lower numeric value  
vertexIndexA Accessor ReadOnly number Return the vertex index that appears first in the order stored.  
vertexIndexB Accessor ReadOnly number Return the vertex index that appears second in the order stored.  

Defined in

Last Updated: 20 June, 2023