Class QuadTree

Index

Constructors

Properties

_divided _points _subdivide _subs capacity rectangle

Methods

insert query queryCircle queryRectangle

Constructors

constructor

new QuadTree(rectangle, capacity): QuadTree
Initializes the instance with a rectangle and a capacity
Parameters
- rectangle: Rectangle
  the instance rectangle area
- capacity: number
  the points capacity
Returns QuadTree
- Defined in Core/Utils/QuadTree.ts:33

Properties

`Private` `Internal` _divided

_divided: boolean

Used to know if the current instance is divided or not (branch or leaf)

`Private` `Readonly` _points

_points: Point[]

The point contained in this instance

`Private` `Readonly` _subdivide

_subdivide: (() => void) = ...

Type declaration

- (): void
- Creates the subtrees, making the instance a branch
  
  Returns void

`Private` `Readonly` _subs

_subs: QuadTree[]

`Readonly` capacity

capacity: number

the points capacity

`Readonly` rectangle

rectangle: Rectangle

the instance rectangle area

Methods

insert

insert(point): boolean
Inserts the given point in the instance, or to its subtrees
Parameters
- point: Point
  the point to insert
Returns boolean
true if the point is added to the instance or one of its subtrees, false if it's not
- Defined in Core/Utils/QuadTree.ts:64

query

query(range, check?): Particle[]
Queries the instance using a Rectangle object, with the given position and the given size
Parameters
- range: BaseRange
  the range to use for querying the tree
- Optional check: ((particle) => boolean)
  the function to check if the particle can be added to the result
  - - (particle): boolean
    - Parameters
      particle: Particle
      Returns boolean
Returns Particle[]
the particles inside the given range
- Defined in Core/Utils/QuadTree.ts:88

queryCircle

queryCircle(position, radius, check?): Particle[]
Queries the instance using a Circle object, with the given position and the given radius
Parameters
- position: ICoordinates
  the circle position
- radius: number
  the circle radius
- Optional check: ((particle) => boolean)
  the function to check if the particle can be added to the result
  - - (particle): boolean
    - Parameters
      particle: Particle
      Returns boolean
Returns Particle[]
the particles inside the given circle
- Defined in Core/Utils/QuadTree.ts:123

queryRectangle

queryRectangle(position, size, check?): Particle[]
Queries the instance using a Rectangle object, with the given position and the given size
Parameters
- position: ICoordinates
  the rectangle position
- size: IDimension
  the rectangle size
- Optional check: ((particle) => boolean)
  the function to check if the particle can be added to the result
  - - (particle): boolean
    - Parameters
      particle: Particle
      Returns boolean
Returns Particle[]
the particles inside the given rectangle
- Defined in Core/Utils/QuadTree.ts:134