Class CanvasEdges

A specialized Map class that manages all edges used to restrict perception in a Scene. Integrates with a Quadtree for efficient spatial queries.

Hierarchy

Map
- CanvasEdges

Index

Accessors

Methods

clear delete getEdges set

Accessors

level

get level(): Level
The Level these edges belong to.

Returns Level

Methods

clear

clear(): CanvasEdges
Returns CanvasEdges
Inherit Doc
Overrides Map.clear

delete

delete(id: any): boolean
Parameters
- id: any
Returns boolean
Inherit Doc
Overrides Map.delete

getEdges

getEdges(
    rect: Rectangle,
    options?: {
        collisionTest?: (edge: Edge) => boolean;
        collisionTestBounds?: boolean;
        includeInnerBounds?: boolean;
        includeOuterBounds?: boolean;
    },
): Set<Edge>
Retrieves edges that overlap with a given rectangle. Utilizes the Quadtree for efficient spatial querying. This function computes edge intersections if necessary.
Parameters
- rect: Rectangle
  The rectangle to query against.
- options: {
      collisionTest?: (edge: Edge) => boolean;
      collisionTestBounds?: boolean;
      includeInnerBounds?: boolean;
      includeOuterBounds?: boolean;
  } = {}
  - OptionalcollisionTest?: (edge: Edge) => boolean
    Collision function to test edge inclusion.
  - OptionalcollisionTestBounds?: boolean
    Apply collision test to bounds?
  - OptionalincludeInnerBounds?: boolean
    Should inner bounds be added?
  - OptionalincludeOuterBounds?: boolean
    Should outer bounds be added?
Returns Set<Edge>
A set of Edge instances that intersect with the provided rectangle.

set

set(id: any, edge: any): CanvasEdges
Parameters
- id: any
- edge: any
Returns CanvasEdges
Inherit Doc
Overrides Map.set