Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MovementSource

A subclass of PointSource which is used when computing the polygonal area where movement is possible.

param object

The Token object which is attempting to move.

Hierarchy

Index

Constructors

Methods

Properties

Accessors

Constructors

constructor

Methods

initialize

  • initialize(data?: {}): void
  • override

    Parameters

    • data: {} = {}

      Returns void

    containsPoint

    • containsPoint(point: Point): boolean

    • A point is contained with the area of the source if it is within both the FOV circle and the LOS polygon.

      Parameters

      • point: Point

        The point to test

      Returns boolean

      Is the point contained

    destroy

    • destroy(): void

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

      Returns void

    refreshSource

    • refreshSource(): void

    _createMeshes

    • _createMeshes(): void

    animate

    • animate(dt: number): any

    • Animate the BaseSource, if an animation is enabled and if it currently has rendered containers.

      Parameters

      • dt: number

        Delta time.

      Returns any

    Protected _updateLosGeometry

    • _updateLosGeometry(polygon: Polygon): void

    • Create or update the source geometry with a polygon shape Triangulate the form and create buffers

      Parameters

      Returns void

    Protected _getPolygonConfiguration

    Protected _createPolygon

    Protected _initializeMeshes

    • _initializeMeshes(polygon: Polygon): void

    Protected _createMesh

    • _createMesh(shaderCls: Function): Mesh

    • Create a new Mesh for this source using a provided shader class

      Parameters

      • shaderCls: Function

        The subclass of AdaptiveLightingShader being used for this Mesh

      Returns Mesh

      The created Mesh

    Protected _updateMesh

    • _updateMesh(mesh: Mesh): Mesh

    • Update the position and size of the mesh each time it is drawn.

      Parameters

      • mesh: Mesh

        The Mesh being updated

      Returns Mesh

      The updated Mesh

    Properties

    object

    object: PlaceableObject

    The PlaceableObject which is the origin of this PointSource.

    active

    active: boolean = false

    A flag for whether this source is currently rendered or not.

    animation

    animation: PointSourceAnimationConfiguration = {}

    The animation configuration applied to this source

    data

    data: any = {}

    The object of data which configures how this source is rendered

    radius

    radius: number = 0

    The maximum radius of emission for this source

    los

    los: PointSourcePolygon

    The restricted line-of-sight polygon that is generated by the origin and radius of this source.

    losMask

    losMask: any = ...

    A Graphics object with pre-computed geometry used for masking based on line-of-sight.

    Protected _flags

    _flags: Object = {}

    Additional information which controls whether certain behaviors of the source must be enforced

    Protected _meshesInit

    _meshesInit: boolean = false

    To track meshes initialization

    Static sourceType

    sourceType: string = "move"
    override

    Static EDGE_OFFSET

    EDGE_OFFSET: number = -8

    The offset in pixels applied to create soft edges.

    Accessors

    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

    sourceType

    • get sourceType(): string

    • The type of source represented by this data structure.

      Returns string

    elevation

    • get elevation(): number

    • The elevation of the object bound to this base source, if any. Returns the canvas primary background elevation otherwise.

      Returns number

    isAnimated

    • get isAnimated(): boolean

    • If the source is animated or not.

      Returns boolean