Class PointMovementSource

A specialized subclass of the BaseEffectSource which describes a movement-based source.

Mixes

PointEffectSource

Hierarchy (View Summary)

BaseEffectSource<BaseEffectSourceData, Polygon, this>
- PointMovementSource

Index

Constructors

constructor

new PointMovementSource(options?: BaseEffectSourceOptions): PointMovementSource
An effect source is constructed by providing configuration options.
Parameters
- Optionaloptions: BaseEffectSourceOptions = {}
  Options which modify the base effect source instance
Returns PointMovementSource
Inherited from BaseEffectSource.constructor

Properties

data

data: BaseEffectSourceData = ...

The data of this source.

object

object: object | null

Some other object which is responsible for this source.

shape

shape: Polygon

The geometric shape of the effect source which is generated later.

`Readonly`sourceId

sourceId: string

The source id linked to this effect source.

suppression

suppression: Record<string, boolean> = {}

Records of suppression strings with a boolean value. If any of this record is true, the source is suppressed.

`Protected`_flags

_flags: Record<string, number | boolean> = {}

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

`Static`defaultData

defaultData: BaseEffectSourceData = ...

Effect source default data.

`Static` `Abstract`effectsCollection

effectsCollection: string

The target collection into the effects canvas group.

`Static`sourceType

sourceType: string = "move"

Accessors

active

get active(): boolean
Is this source currently active? A source is active if it is attached to an effect collection and is not disabled or suppressed.

Returns boolean
Inherited from PointEffectSourceMixin(BaseEffectSource).active

attached

get attached(): boolean
Is this source attached to an effect collection?

Returns boolean
Inherited from PointEffectSourceMixin(BaseEffectSource).attached

effectsCollection

get effectsCollection(): Collection<
string,
BaseEffectSource<BaseEffectSourceData, Polygon>,
>
The EffectsCanvasGroup collection linked to this effect source.

Returns Collection<string, BaseEffectSource<BaseEffectSourceData, Polygon>>
Inherited from PointEffectSourceMixin(BaseEffectSource).effectsCollection

elevation

get elevation(): number
The elevation bound to this source.

Returns number
Inherited from PointEffectSourceMixin(BaseEffectSource).elevation

level

get level(): documents.Level
The level this source is in.

Returns documents.Level
Inherited from PointEffectSourceMixin(BaseEffectSource).level

suppressed

get suppressed(): boolean
Is this source temporarily suppressed?

Returns boolean
Inherited from PointEffectSourceMixin(BaseEffectSource).suppressed

updateId

get updateId(): number
Returns the update ID associated with this source. The update ID is increased whenever the shape of the source changes.

Returns number
Inherited from PointEffectSourceMixin(BaseEffectSource).updateId

x

get x(): number
The x-coordinate of the point source origin.

Returns number
Inherited from PointEffectSourceMixin(BaseEffectSource).x

y

get y(): number
The y-coordinate of the point source origin.

Returns number
Inherited from PointEffectSourceMixin(BaseEffectSource).y

Methods

add

add(): void
Add this BaseEffectSource instance to the active collection.

Returns void
Inherited from BaseEffectSource.add

destroy

destroy(): void
Steps that must be performed when the source is destroyed.

Returns void
Inherited from BaseEffectSource.destroy

initialize

initialize(
data?: Partial<BaseEffectSourceData>,
options?: { reset?: boolean },
): PointMovementSource
Initialize and configure the source using provided data.
Parameters
- data: Partial<BaseEffectSourceData> = {}
  Provided data for configuration
- options: { reset?: boolean } = {}
  Additional options which modify source initialization
  - Optionalreset?: boolean
    Should source data be reset to default values before applying changes?
Returns PointMovementSource
The initialized source

Inherited from BaseEffectSource.initialize

refresh

refresh(): void
Refresh the state and uniforms of the source. Only active sources are refreshed.

Returns void
Inherited from BaseEffectSource.refresh

remove

remove(): void
Remove this BaseEffectSource instance from the active collection.

Returns void
Inherited from BaseEffectSource.remove

testPoint

testPoint(point: ElevatedPoint): boolean
Test whether the point is contained within the shape of the source.
Parameters
- point: ElevatedPoint
  The point.
Returns boolean
Is inside the source?

Inherited from BaseEffectSource.testPoint

`Protected`_configure

_configure(changes: Partial<BaseEffectSourceData>): void
Protected
Subclass specific configuration steps. Occurs after data initialization and shape computation. Only called if the source is attached and not disabled and its data or shapes have changed.
Parameters
- changes: Partial<BaseEffectSourceData>
  Changes to the source data which were applied
Returns void
Inherited from BaseEffectSource._configure

`Protected`_couldShapesChange

_couldShapesChange(changes: Partial<BaseEffectSourceData>): boolean
Protected
If true is returned, BaseEffectSource#_createShapes is called in BaseEffectSource#initialize.
Parameters
- changes: Partial<BaseEffectSourceData>
  Changes to the source data which were applied
Returns boolean
Inherited from BaseEffectSource._couldShapesChange

`Protected` `Abstract`_createShapes

_createShapes(): void
Protected
Create the polygon shape (or shapes) for this source using configured data.

Returns void
Inherited from BaseEffectSource._createShapes

`Protected`_destroy

_destroy(): void
Protected
Subclass specific destruction steps.

Returns void
Inherited from BaseEffectSource._destroy

`Protected`_initialize

_initialize(data: Partial<BaseEffectSourceData>): void
Protected
Subclass specific data initialization steps.
Parameters
- data: Partial<BaseEffectSourceData>
  Provided data for configuration
Returns void
Inherited from BaseEffectSource._initialize

`Protected` `Abstract`_refresh

_refresh(): void
Protected
Subclass-specific refresh steps.

Returns void
Inherited from BaseEffectSource._refresh

Class PointMovementSource

Mixes

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PointMovementSource

Properties

data

object

shape

ReadonlysourceId

suppression

Protected_flags

StaticdefaultData

Static AbstracteffectsCollection

StaticsourceType

Accessors

active

Returns boolean

attached

Returns boolean

effectsCollection

Returns Collection<string, BaseEffectSource<BaseEffectSourceData, Polygon>>

elevation

Returns number

level

Returns documents.Level

suppressed

Returns boolean

updateId

Returns number

x

Returns number

y

Returns number

Methods

add

Returns void

destroy

Returns void

initialize

Parameters

Optionalreset?: boolean

Returns PointMovementSource

refresh

Returns void

remove

Returns void

testPoint

Parameters

Returns boolean

Protected_configure

Parameters

Returns void

Protected_couldShapesChange

Parameters

Returns boolean

Protected Abstract_createShapes

Returns void

Protected_destroy

Returns void

Protected_initialize

Parameters

Returns void

Protected Abstract_refresh

Returns void

Settings

On This Page

`Readonly`sourceId

`Protected`_flags

`Static`defaultData

`Static` `Abstract`effectsCollection

`Static`sourceType

`Optional`reset?: boolean

`Protected`_configure

`Protected`_couldShapesChange

`Protected` `Abstract`_createShapes

`Protected`_destroy

`Protected`_initialize

`Protected` `Abstract`_refresh