API Reference > geometry-core > 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:
1 if they share start and end in the same order
 -1 if they share start and end in reversed order
* 0 otherwise.		  

Inherited methods

Name Inherited from Description
__@iterator(): IterableIterator<number> [Float64Array.Symbol  
copyWithin(target: number, start: number, end?: number): this Float64Array Returns the this object after copying a section of the array identified by start and end
to the same array starting at position target
entries(): IterableIterator<[number, number]> Float64Array Returns an array of key, value pairs for every entry in the array
every(callbackfn: (value: number, index: number, array: Float64Array) => boolean, thisArg?: any): boolean Float64Array Determines whether all the members of an array satisfy the specified test.
fill(value: number, start?: number, end?: number): this Float64Array Returns the this object after filling the section identified by start and end with value
filter(callbackfn: (value: number, index: number, array: Float64Array) => any, thisArg?: any): Float64Array Float64Array Returns the elements of an array that meet the condition specified in a callback function.
find(predicate: (value: number, index: number, obj: Float64Array) => boolean, thisArg?: any): number | undefined Float64Array Returns the value of the first element in the array where predicate is true, and undefined
otherwise.
findIndex(predicate: (value: number, index: number, obj: Float64Array) => boolean, thisArg?: any): number Float64Array Returns the index of the first element in the array where predicate is true, and -1
otherwise.
forEach(callbackfn: (value: number, index: number, array: Float64Array) => void, thisArg?: any): void Float64Array Performs the specified action for each element in an array.
includes(searchElement: number, fromIndex?: number): boolean Float64Array Determines whether an array includes a certain element, returning true or false as appropriate.
indexOf(searchElement: number, fromIndex?: number): number Float64Array Returns the index of the first occurrence of a value in an array.
join(separator?: string): string Float64Array Adds all the elements of an array separated by the specified separator string.
keys(): IterableIterator<number> Float64Array Returns an list of keys in the array
lastIndexOf(searchElement: number, fromIndex?: number): number Float64Array Returns the index of the last occurrence of a value in an array.
map(callbackfn: (value: number, index: number, array: Float64Array) => number, thisArg?: any): Float64Array Float64Array Calls a defined callback function on each element of an array, and returns an array that
contains the results.
reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array) => number): number Float64Array Calls the specified callback function for all the elements in an array.
reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array) => number, initialValue: number): number Float64Array  
reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Float64Array) => U, initialValue: U): U Float64Array Calls the specified callback function for all the elements in an array.
reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array) => number): number Float64Array Calls the specified callback function for all the elements in an array, in descending order.
reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: Float64Array) => number, initialValue: number): number Float64Array  
reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: Float64Array) => U, initialValue: U): U Float64Array Calls the specified callback function for all the elements in an array, in descending order.
reverse(): Float64Array Float64Array Reverses the elements in an Array.
set(array: ArrayLike<number>, offset?: number): void Float64Array Sets a value or an array of values.
slice(start?: number, end?: number): Float64Array Float64Array Returns a section of an array.
some(callbackfn: (value: number, index: number, array: Float64Array) => boolean, thisArg?: any): boolean Float64Array Determines whether the specified callback function returns true for any element of an array.
sort(compareFn?: (a: number, b: number) => number): this Float64Array Sorts an array.
subarray(begin: number, end?: number): Float64Array Float64Array Gets a new Float64Array view of the ArrayBuffer store for this array, referencing the elements
at begin, inclusive, up to end, exclusive.
toLocaleString(): string Float64Array Converts a number to a string by using the current locale.
toString(): string Float64Array Returns a string representation of an array.
values(): IterableIterator<number> Float64Array Returns an list of values in the array

Properties

Name Type Description
facetIndex Accessor ReadOnly number Return the facet index.  
Float64Array Static Float64ArrayConstructor    
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.  

Inherited properties

Name Type Inherited from Description
__@toStringTag "Float64Array" = undefined [Float64Array.Symbol  
buffer ArrayBufferLike Float64Array The ArrayBuffer instance referenced by the array.
byteLength number Float64Array The length in bytes of the array.
byteOffset number Float64Array The offset in bytes of the array.
BYTES_PER_ELEMENT number Float64Array The size in bytes of each element in the array.
length number Float64Array The length of the array.

Defined in

Last Updated: 08 January, 2020