Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PointSource

An abstract base class which defines a framework for effect sources which originate radially from a specific point. This abstraction is used by the LightSource, VisionSource, SoundSource, and MovementSource subclasses.

example

A standard PointSource lifecycle:

const source = new PointSource({object}); // Create the point source
source.initialize(data);                  // Configure the point source with new data
source.refresh();                         // Refresh the point source
source.destroy();                         // Destroy the point source
param [options]
param [options.object]

Some other object which is responsible for this source

abstract

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

object

object: any

data

data: PointSourceData = {}

The data of this source.

shape

shape: PointSourcePolygon | Polygon

The polygonal shape of the point source, generated from its origin, radius, and other data.

Protected _flags

_flags: Object = {}

A collection of boolean flags which control rendering and refresh behavior for the source.

Private #updateId

#updateId: number = 0

Private #active

#active: boolean = false

Private #initialized

#initialized: boolean = false

Static sourceType

sourceType: string

The type of source represented by this data structure. Each subclass must implement this attribute.

Accessors

updateId

  • get updateId(): number

  • Returns the update ID associated with this point source. The update ID is increased whenever the source is initialized.

    Returns number

active

  • get active(): boolean

  • Is this point source currently active? Returns false if the source is disabled, temporarily suppressed, or not initialized.

    Returns boolean

disabled

  • get disabled(): boolean

  • Is this source currently disabled? Returns false if the source hasn't been initialized yet.

    Returns boolean

initialized

  • get initialized(): boolean

  • Has this point source been initialized?

    Returns boolean

x

  • get x(): number

  • The x-coordinate of the point source origin.

    Returns number

y

  • get y(): number

  • The y-coordinate of the point source origin.

    Returns number

elevation

  • get elevation(): number

  • The elevation bound to this source.

    Returns number

radius

  • get radius(): number

  • A convenience reference to the radius of the source.

    Returns number

Methods

initialize

  • Initialize and configure the PointSource using provided data.

    Parameters

    • data: any = {}

      Provided data for configuration

    Returns PointSource

    The configured source

refresh

  • refresh(): void

  • Refresh the state and uniforms of the PointSource.

    Returns void

destroy

  • destroy(): void

  • Steps that must be performed when the base source is destroyed.

    Returns void

Protected _initialize

  • _initialize(data: any): void

  • Subclass specific data initialization steps. This method is responsible for populating the instance data object.

    Parameters

    • data: any

      Provided data for configuration

    Returns void

Protected _configure

  • _configure(changes?: any): void

  • Subclass specific configuration steps. Occurs after data initialization and shape computation.

    Parameters

    • changes: any = {}

      The fields of data which changed during initialization

    Returns void

Protected _isActive

  • _isActive(): boolean

  • Test whether this source should be active under current conditions?

    Returns boolean

Protected _refresh

  • _refresh(): void

  • Subclass-specific refresh steps.

    abstract

    Returns void

Protected _destroy

  • _destroy(): void

  • Subclass specific destruction steps.

    abstract

    Returns void

Protected _getPolygonConfiguration

Protected _createPolygon

  • Create the polygon shape for this source using configured data.

    Returns PointSourcePolygon