Foundry Virtual Tabletop - API Documentation - Version 14
    Preparing search index...

    Class PointVisionSource

    A specialized subclass of RenderedEffectSource which represents a source of point-based vision.

    Hierarchy

    • any
      • PointVisionSource
    Index

    Constructors

    constructor

    Properties

    _visionModeActivated blinded light los visionMode visionModeOverrides _initializeShaderKeys _refreshUniformsKeys defaultData EDGE_OFFSET effectsCollection sourceType _brightLightingLevel _dimLightingLevel

    Accessors

    fov isAnimated isBlinded lightRadius preferred radius _layers

    Methods

    _configure _configureLayer _configureShaders _createShapes _getPolygonConfiguration _initialize _updateBackgroundUniforms _updateColorationUniforms _updateCommonUniforms _updateIlluminationUniforms _createLightPolygon _createRestrictedPolygon _updateVisionMode _updateVisionModeUniforms getCorrectedColor getCorrectedLevel

    Constructors

    Properties

    Internal_visionModeActivated

    _visionModeActivated: boolean = false

    The vision mode activation flag for handlers

    blinded: Record<string, boolean> = {}

    Records of blinding strings with a boolean value. By default, if any of this record is true, the source is blinded.

    light: PointSourcePolygon

    The polygon of light perception.

    los: PointSourcePolygon

    The unconstrained LOS polygon.

    visionMode: any = null

    The vision mode linked to this VisionSource

    visionModeOverrides: object = {}

    Data overrides that could happen with blindness vision mode.

    Static_initializeShaderKeys

    _initializeShaderKeys: string[] = ...

    Static_refreshUniformsKeys

    _refreshUniformsKeys: string[] = ...
    defaultData: any = ...
    EDGE_OFFSET: number = -2
    effectsCollection: string = "visionSources"
    sourceType: string = "sight"

    Protected Static_brightLightingLevel

    _brightLightingLevel: number = LIGHTING_LEVELS.BRIGHT

    The corresponding lighting levels for bright light.

    Protected Static_dimLightingLevel

    _dimLightingLevel: number = LIGHTING_LEVELS.DIM

    The corresponding lighting levels for dim light.

    Accessors

    • get fov(): any

      An alias for the shape of the vision source.

      Returns any

    • get isAnimated(): boolean

      Is the rendered source animated?

      Returns boolean

    • get isBlinded(): boolean

      Is this source temporarily blinded?

      Returns boolean

    • get lightRadius(): number

      Light perception radius of this vision source, taking into account if the source is blinded.

      Returns number

    • get preferred(): boolean

      If this vision source background is rendered into the lighting container.

      Returns boolean

    • get radius(): any

      Returns any

    Static_layers

    • get _layers(): {
          background: {
              blendMode: string;
              defaultShader: typeof BackgroundVisionShader;
          };
          coloration: {
              blendMode: string;
              defaultShader: typeof ColorationVisionShader;
          };
          illumination: {
              blendMode: string;
              defaultShader: typeof IlluminationVisionShader;
          };
      }

      Returns {
          background: {
              blendMode: string;
              defaultShader: typeof BackgroundVisionShader;
          };
          coloration: {
              blendMode: string;
              defaultShader: typeof ColorationVisionShader;
          };
          illumination: {
              blendMode: string;
              defaultShader: typeof IlluminationVisionShader;
          };
      }

    Methods

    _configure

    • _configure(changes: any): void

      Parameters

      • changes: any

      Returns void

    _configureLayer

    • _configureLayer(layer: any, layerId: any): void

      Parameters

      • layer: any
      • layerId: any

      Returns void

    _configureShaders

    • _configureShaders(): {}

      Returns {}

    _createShapes

    • _createShapes(): void

      Returns void

    _getPolygonConfiguration

    • _getPolygonConfiguration(): any

      Returns any

    _initialize

    • _initialize(data: any): void

      Parameters

      • data: any

      Returns void

    _updateBackgroundUniforms

    • _updateBackgroundUniforms(): void

      Returns void

    _updateColorationUniforms

    • _updateColorationUniforms(): void

      Returns void

    _updateCommonUniforms

    • _updateCommonUniforms(shader: any): void

      Parameters

      • shader: any

      Returns void

    _updateIlluminationUniforms

    • _updateIlluminationUniforms(): void

      Returns void

    Protected_createLightPolygon

    • _createLightPolygon(): PointSourcePolygon
      Protected

      Creates the polygon that represents light perception. If the light perception radius is unconstrained, no new polygon instance is created; instead the LOS polygon of this vision source is returned.

      Returns PointSourcePolygon

      The new polygon or this.los.

    Protected_createRestrictedPolygon

    • _createRestrictedPolygon(): PointSourcePolygon
      Protected

      Create a restricted FOV polygon by limiting the radius of the unrestricted LOS polygon. If the vision radius is unconstrained, no new polygon instance is created; instead the LOS polygon of this vision source is returned.

      Returns PointSourcePolygon

      The new polygon or this.los.

    Protected_updateVisionMode

    • _updateVisionMode(): void
      Protected

      Responsible for assigning the Vision Mode and calling the activation and deactivation handlers.

      Returns void

    Protected_updateVisionModeUniforms

    • _updateVisionModeUniforms(
          shader: AdaptiveVisionShader,
          vmUniforms: Record<string, any>,
      ): void
      Protected

      Update layer uniforms according to vision mode uniforms, if any.

      Parameters

      • shader: AdaptiveVisionShader

        The shader being updated.

      • vmUniforms: Record<string, any>

        The targeted layer.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods