Class RTree

constructor

• new RTree(m?: number, M?: number, d?: number): RTree

  Parameters

  • m: number = 2

    minimum number of entries in a node, m should be little or equal than M.

  • M: number = 5

    maximum number of entries in a node.

  • d: number = 2

    dimension of rtree

  Returns RTree

Readonlym

ReadonlyM

root

clear

• clear(): void

  clear the rtree to empty.

  Returns void

delete

• delete(data: any, toMbrFunc?: ToRtreeMBRFunc): void

  Parameters

  • data: any

    the data need delete from the rtree

  • OptionaltoMbrFunc: ToRtreeMBRFunc

    the function that convert the data to mbr toMbrFunc is optional. if not provide toMbrFunc parameter, rtree will use predefined ToRtreeMBRFunc to convert this data. the predefined ToRtreeMBRFunc should be set by calling rtree.setToMbrFunc function.

  Returns void

getDepthFromNode

• getDepthFromNode(node: RTreeNode): number

  Parameters

  • node: RTreeNode

  Returns number

  get depth from node downward leaf node depth is zero.

getLeafLevel

• getLeafLevel(): number

  Returns number

  the level of leaf node the root level is zero.

insert

• insert(data: any, toMbrFunc?: ToRtreeMBRFunc): void

  insert a data into rtree

  Parameters

  • data: any

    the data or object

  • OptionaltoMbrFunc: ToRtreeMBRFunc

    the function that convert the data to mbr toMbrFunc is optional. if not provide toMbrFunc parameter, rtree will use predefined ToRtreeMBRFunc to convert this data. the predefined ToRtreeMBRFunc should be set by calling rtree.setToMbrFunc function.

  Returns void

isEmpty

• isEmpty(): boolean

  is the rtree is empty

  Returns boolean

search

• search(mbr: RTreeMBR, check_func: RTreeSearchCheckFuncType): RTreeEntry[]

  use mbr to search for leaf entries that check func returns true

  Parameters

  • mbr: RTreeMBR

    search mbr

  • check_func: RTreeSearchCheckFuncType

    check the entry and the mbr is matched

  Returns RTreeEntry[]

  the leaf entries that match. these entries point to records contain the target spatial data.

search_overlap

• search_overlap(mbr: RTreeMBR): RTreeEntry[]

  search data that overlap with mbr.

  Parameters

  • mbr: RTreeMBR

    the mbr

  Returns RTreeEntry[]

  some of leaf entries. these entries point to records contain the target spatial data.

setProbe

• setProbe(probe: Probe): void

  Parameters

  • probe: Probe

  Returns void

setToMbrFunc

• setToMbrFunc(f: ToRtreeMBRFunc): void

  Parameters

  • f: ToRtreeMBRFunc

  Returns void