Class PointDarknessSource

A specialized subclass of the BaseLightSource which renders a source of darkness as a point-based effect.

Mixes

Hierarchy (view full)

BaseLightSource<this>
- PointDarknessSource

Constructors

constructor

new PointDarknessSource(options?): PointDarknessSource
An effect source is constructed by providing configuration options.
Parameters
- Optional options: BasseEffectSourceOptions = {}
  Options which modify the base effect source instance
Returns PointDarknessSource
Inherited from BaseLightSource.constructor

Properties

edges

edges: Edge[] = []

The Edge instances added by this darkness source.

ratio

ratio: number = 1

A ratio of dim:bright as part of the source radius

`Protected` _visualShape

_visualShape: SourceShape

The optional geometric shape is solely utilized for visual representation regarding darkness sources. Used only when an additional radius is added for visuals.

`Protected` _padding

_padding: number = ...

Padding applied on the darkness source shape for visual appearance only. Note: for now, padding is increased radius. It might evolve in a future release.

`Private` #borderDistance

#borderDistance: number = 0

The normalized border distance.

`Static` effectsCollection

effectsCollection: string = "darknessSources"

`Static` _dimLightingLevel

_dimLightingLevel: number = LIGHTING_LEVELS.HALFDARK

`Static` _brightLightingLevel

_brightLightingLevel: number = LIGHTING_LEVELS.DARKNESS

`Static` sourceType

sourceType: string = "light"

`Static` _initializeShaderKeys

_initializeShaderKeys: string[] = ...

`Static` _refreshUniformsKeys

_refreshUniformsKeys: string[] = ...

`Static` defaultData

defaultData: any = ...

Effect source default data.

`Static` EDGE_OFFSET

EDGE_OFFSET: number = -8

The offset in pixels applied to create soft edges.

Accessors

darkness

get darkness(): PointSourceMesh
A convenience accessor to the darkness layer mesh.

Returns PointSourceMesh

`Static` ANIMATIONS

get ANIMATIONS(): any
Returns any

`Static` _layers

get _layers(): {
    darkness: {
        defaultShader: any;
        blendMode: string;
    };
}
Returns {
    darkness: {
        defaultShader: any;
        blendMode: string;
    };
}
- darkness: {
  defaultShader: any;
  blendMode: string;
  }
  - defaultShader: any
  - blendMode: string

Methods

_initialize

_initialize(data): void
Parameters
- data: any
Returns void
Overrides BaseLightSource._initialize

_createShapes

_createShapes(): void
Returns void
Inherit Doc

_configure

_configure(changes): void
Parameters
- changes: any
Returns void
Inherit Doc

_getPolygonConfiguration

_getPolygonConfiguration(): any
Returns any
Inherit Doc

_updateGeometry

_updateGeometry(): void
Returns void

_updateDarknessUniforms

_updateDarknessUniforms(): void
Update the uniforms of the shader on the darkness layer.

Returns void

_destroy

_destroy(): void
Returns void
Inherit Doc

_updateColorationUniforms

_updateColorationUniforms(): void
Update shader uniforms used for the coloration layer.

Returns void
Inherited from BaseLightSource._updateColorationUniforms

_updateIlluminationUniforms

_updateIlluminationUniforms(): void
Update shader uniforms used for the illumination layer.

Returns void
Inherited from BaseLightSource._updateIlluminationUniforms

_updateBackgroundUniforms

_updateBackgroundUniforms(): void
Update shader uniforms used for the background layer.

Returns void
Inherited from BaseLightSource._updateBackgroundUniforms

_updateCommonUniforms

_updateCommonUniforms(shader): void
Parameters
- shader: any
Returns void
Inherited from BaseLightSource._updateCommonUniforms

animateTorch

animateTorch(dt, options?): void
An animation with flickering ratio and light intensity.
Parameters
- dt: number
  Delta time
- Optional options: {
      speed: number;
      intensity: number;
      reverse: boolean;
  } = {}
  Additional options which modify the flame animation
  - speed: number
    The animation speed, from 0 to 10
  - intensity: number
    The animation intensity, from 1 to 10
  - reverse: boolean
    Reverse the animation direction
Returns void
Inherited from BaseLightSource.animateTorch

animateFlickering

animateFlickering(dt, options?): void
An animation with flickering ratio and light intensity
Parameters
- dt: number
  Delta time
- Optional options: {
      speed: number;
      intensity: number;
      amplification: number;
      reverse: boolean;
  } = {}
  Additional options which modify the flame animation
  - speed: number
    The animation speed, from 0 to 10
  - intensity: number
    The animation intensity, from 1 to 10
  - amplification: number
    Noise amplification (>1) or dampening (<1)
  - reverse: boolean
    Reverse the animation direction
Returns void
Inherited from BaseLightSource.animateFlickering

animatePulse

animatePulse(dt, options?): void
A basic "pulse" animation which expands and contracts.
Parameters
- dt: number
  Delta time
- Optional options: {
      speed: number;
      intensity: number;
      reverse: boolean;
  } = {}
  Additional options which modify the pulse animation
  - speed: number
    The animation speed, from 0 to 10
  - intensity: number
    The animation intensity, from 1 to 10
  - reverse: boolean
    Reverse the animation direction
Returns void
Inherited from BaseLightSource.animatePulse

`Private` #createShapeFromVisualShape

#createShapeFromVisualShape(radius): PointSourcePolygon
Create a radius constrained polygon from the visual shape polygon. If the visual shape is not created, no polygon is created.
Parameters
- radius: number
  The radius to constraint to.
Returns PointSourcePolygon
The new polygon or null if no visual shape is present.

`Private` #createEdges

#createEdges(): void
Create the Edge instances that correspond to this darkness source.

Returns void

`Private` #deleteEdges

#deleteEdges(): void
Remove edges from the active Edges collection.

Returns void

`Static` getCorrectedLevel

getCorrectedLevel(level): number
Get corrected level according to level and active vision mode data.
Parameters
- level: LIGHTING_LEVELS
Returns number
The corrected level.

Inherited from BaseLightSource.getCorrectedLevel

`Static` getCorrectedColor

getCorrectedColor(level, colorDim, colorBright, colorBackground?): typeof Color
Get corrected color according to level, dim color, bright color and background color.
Parameters
- level: LIGHTING_LEVELS
- colorDim: typeof Color
- colorBright: typeof Color
- Optional colorBackground: typeof Color
Returns typeof Color
Inherited from BaseLightSource.getCorrectedColor

Class PointDarknessSource

Mixes

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PointDarknessSource

Properties

edges

ratio

Protected _visualShape

Protected _padding

Private #borderDistance

Static effectsCollection

Static _dimLightingLevel

Static _brightLightingLevel

Static sourceType

Static _initializeShaderKeys

Static _refreshUniformsKeys

Static defaultData

Static EDGE_OFFSET

Accessors

darkness

Returns PointSourceMesh

Static ANIMATIONS

Returns any

Static _layers

Returns { darkness: { defaultShader: any; blendMode: string; }; }

darkness: { defaultShader: any; blendMode: string; }

defaultShader: any

blendMode: string

Methods

_initialize

Parameters

Returns void

_createShapes

Returns void

Inherit Doc

_configure

Parameters

Returns void

Inherit Doc

_getPolygonConfiguration

Returns any

Inherit Doc

_updateGeometry

Returns void

_updateDarknessUniforms

Returns void

_destroy

Returns void

Inherit Doc

_updateColorationUniforms

Returns void

_updateIlluminationUniforms

Returns void

_updateBackgroundUniforms

Returns void

_updateCommonUniforms

Parameters

Returns void

animateTorch

Parameters

speed: number

intensity: number

reverse: boolean

Returns void

animateFlickering

Parameters

speed: number

intensity: number

amplification: number

reverse: boolean

Returns void

animatePulse

`Protected` _visualShape

`Protected` _padding

`Private` #borderDistance

`Static` effectsCollection

`Static` _dimLightingLevel

`Static` _brightLightingLevel

`Static` sourceType

`Static` _initializeShaderKeys

`Static` _refreshUniformsKeys

`Static` defaultData

`Static` EDGE_OFFSET

`Static` ANIMATIONS

`Static` _layers

Returns {
darkness: {
defaultShader: any;
blendMode: string;
};
}

darkness: {
defaultShader: any;
blendMode: string;
}

`Private` #createShapeFromVisualShape

`Private` #createEdges

`Private` #deleteEdges

`Static` getCorrectedLevel

`Static` getCorrectedColor