From 2556a797e0be1ef34d3a42a831656d790d358897 Mon Sep 17 00:00:00 2001 From: googlemaps-bot Date: Mon, 11 Nov 2024 06:18:04 +0000 Subject: [PATCH] chore(deps-dev): bump eslint-plugin-jest from 28.5.0 to 28.9.0 (#1131) Bumps [eslint-plugin-jest](https://github.com/jest-community/eslint-plugin-jest) from 28.5.0 to 28.9.0. - [Release notes](https://github.com/jest-community/eslint-plugin-jest/releases) - [Changelog](https://github.com/jest-community/eslint-plugin-jest/blob/main/CHANGELOG.md) - [Commits](https://github.com/jest-community/eslint-plugin-jest/compare/v28.5.0...v28.9.0) --- updated-dependencies: - dependency-name: eslint-plugin-jest dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> e2323f7add09ec0fb3b6e2bb5852ecc68997f794 --- classes/ThreeJSOverlayView.html | 58 +++++++++++------------ functions/latLngToVector3Relative.html | 2 +- functions/latLngToXY.html | 2 +- functions/toLatLngAltitudeLiteral.html | 2 +- functions/xyToLatLng.html | 2 +- interfaces/RaycastOptions.html | 8 ++-- interfaces/ThreeJSOverlayViewOptions.html | 14 +++--- types/LatLngTypes.html | 2 +- variables/EARTH_RADIUS.html | 2 +- variables/WORLD_SIZE.html | 2 +- 10 files changed, 47 insertions(+), 47 deletions(-) diff --git a/classes/ThreeJSOverlayView.html b/classes/ThreeJSOverlayView.html index cbb621ee..f4800294 100644 --- a/classes/ThreeJSOverlayView.html +++ b/classes/ThreeJSOverlayView.html @@ -1,5 +1,5 @@ ThreeJSOverlayView | @googlemaps/three

Class ThreeJSOverlayView

Add a three.js scene as a Google Maps WebGLOverlayView.

-

Implements

  • WebGLOverlayView

Constructors

constructor +

Implements

  • WebGLOverlayView

Constructors

constructor

Properties

anchor animationMode camera @@ -33,55 +33,55 @@ setValues unbind unbindAll -

Constructors

constructor

Properties

Protected anchor

anchor: LatLngAltitudeLiteral

The anchor for the scene.

-

animationMode

animationMode: "always" | "ondemand" = "ondemand"

The animation mode controls when the overlay will redraw, either +

Constructors

constructor

Properties

Protected anchor

anchor: LatLngAltitudeLiteral

The anchor for the scene.

+

animationMode

animationMode: "always" | "ondemand" = "ondemand"

The animation mode controls when the overlay will redraw, either continuously (always) or on demand (ondemand). When using the on demand mode, the overlay will re-render whenever the map renders (camera movements) or when requestRedraw() is called.

To achieve animations in this mode, you can either use an outside animation-loop that calls requestRedraw() as long as needed or call requestRedraw() from within the onBeforeRender function to

-

Protected Readonly camera

camera: PerspectiveCamera

Protected Readonly overlay

overlay: WebGLOverlayView

Protected Readonly projectionMatrixInverse

projectionMatrixInverse: Matrix4 = ...

Protected raycaster

raycaster: Raycaster = ...

Protected renderer

renderer: WebGLRenderer

Protected Readonly rotationArray

rotationArray: Float32Array = ...

Protected Readonly rotationInverse

rotationInverse: Quaternion = ...

Readonly scene

scene: Scene

The scene object to render in the overlay. If no scene is specified, a +

Protected Readonly camera

camera: PerspectiveCamera

Protected Readonly overlay

overlay: WebGLOverlayView

Protected Readonly projectionMatrixInverse

projectionMatrixInverse: Matrix4 = ...

Protected raycaster

raycaster: Raycaster = ...

Protected renderer

renderer: WebGLRenderer

Protected Readonly rotationArray

rotationArray: Float32Array = ...

Protected Readonly rotationInverse

rotationInverse: Quaternion = ...

Readonly scene

scene: Scene

The scene object to render in the overlay. If no scene is specified, a new scene is created and can be accessed via overlay.scene.

-

Methods

addListener

  • addListener(eventName, handler): MapsEventListener

  • Adds the given listener function to the given event name. Returns an +

Methods

addListener

  • addListener(eventName, handler): MapsEventListener

  • Adds the given listener function to the given event name. Returns an identifier for this listener that can be used with google.maps.event.removeListener.

    -

    Parameters

    • eventName: string
    • handler: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns MapsEventListener

bindTo

  • bindTo(key, target, targetKey?, noNotify?): void

  • Binds a View to a Model.

    -

    Parameters

    • key: string
    • target: MVCObject
    • Optional targetKey: string
    • Optional noNotify: boolean

    Returns void

get

  • get(key): any

  • Gets a value.

    -

    Parameters

    • key: string

    Returns any

getMap

  • getMap(): Map

  • Returns the map the overlay is added to.

    -

    Returns Map

latLngAltitudeToVector3

  • latLngAltitudeToVector3(position, target?): Vector3

  • Convert coordinates from WGS84 Latitude Longitude to world-space +

    Parameters

    • eventName: string
    • handler: ((...args) => void)
        • (...args): void

        • Parameters

          • Rest ...args: unknown[]

          Returns void

    Returns MapsEventListener

bindTo

  • bindTo(key, target, targetKey?, noNotify?): void

  • Binds a View to a Model.

    +

    Parameters

    • key: string
    • target: MVCObject
    • Optional targetKey: string
    • Optional noNotify: boolean

    Returns void

get

  • get(key): any

  • Gets a value.

    +

    Parameters

    • key: string

    Returns any

getMap

  • getMap(): Map

  • Returns the map the overlay is added to.

    +

    Returns Map

latLngAltitudeToVector3

  • latLngAltitudeToVector3(position, target?): Vector3

  • Convert coordinates from WGS84 Latitude Longitude to world-space coordinates while taking the origin and orientation into account.

    -

    Parameters

    Returns Vector3

notify

  • notify(key): void

  • Notify all observers of a change on this property. This notifies both +

    Parameters

    Returns Vector3

notify

  • notify(key): void

  • Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

    -

    Parameters

    • key: string

    Returns void

onAdd

  • onAdd(): void

  • Overwrite this method to fetch or create intermediate data structures +

    Parameters

    • key: string

    Returns void

onAdd

  • onAdd(): void

  • Overwrite this method to fetch or create intermediate data structures before the overlay is drawn that don’t require immediate access to the WebGL rendering context.

    -

    Returns void

onBeforeDraw

  • onBeforeDraw(): void

  • Overwrite this method to update your scene just before a new frame is +

    Returns void

onBeforeDraw

  • onBeforeDraw(): void

  • Overwrite this method to update your scene just before a new frame is drawn.

    -

    Returns void

onContextLost

  • onContextLost(): void

  • This method is called when the rendering context is lost for any reason, +

    Returns void

onContextLost

  • onContextLost(): void

  • This method is called when the rendering context is lost for any reason, and is where you should clean up any pre-existing GL state, since it is no longer needed.

    -

    Returns void

onContextRestored

  • onContextRestored(options): void

  • This method is called once the rendering context is available. Use it to +

    Returns void

onContextRestored

  • onContextRestored(options): void

  • This method is called once the rendering context is available. Use it to initialize or bind any WebGL state such as shaders or buffer objects.

    Parameters

    • options: WebGLStateOptions

      that allow developers to restore the GL context.

      -

    Returns void

onDraw

  • onDraw(options): void

  • Implement this method to draw WebGL content directly on the map. Note +

Returns void

onDraw

  • onDraw(options): void

  • Implement this method to draw WebGL content directly on the map. Note that if the overlay needs a new frame drawn then call ThreeJSOverlayView.requestRedraw.

    Parameters

    • options: WebGLDrawOptions

      that allow developers to render content to an associated Google basemap.

      -

    Returns void

onRemove

  • onRemove(): void

  • This method is called when the overlay is removed from the map with +

Returns void

onRemove

  • onRemove(): void

  • This method is called when the overlay is removed from the map with overlay.setMap(null), and is where you can remove all intermediate objects created in onAdd.

    -

    Returns void

onStateUpdate

  • onStateUpdate(options): void

  • Overwrite this method to handle any GL state updates outside the +

    Returns void

onStateUpdate

  • onStateUpdate(options): void

  • Overwrite this method to handle any GL state updates outside the render animation frame.

    -

    Parameters

    • options: WebGLStateOptions

    Returns void

raycast

  • raycast(p, options?): Intersection<Object3D<Object3DEventMap>>[]

  • Runs raycasting for the specified screen-coordinates against all objects +

    Parameters

    • options: WebGLStateOptions

    Returns void

raycast

  • raycast(p, options?): Intersection<Object3D<Object3DEventMap>>[]

  • Runs raycasting for the specified screen-coordinates against all objects in the scene.

    Parameters

    • p: Vector2

      normalized screenspace coordinates of the mouse-cursor. x/y are in range [-1, 1], y is pointing up.

    • Optional options: RaycastOptions

      raycasting options. In this case the recursive option has no effect as it is always recursive.

    Returns Intersection<Object3D<Object3DEventMap>>[]

    the list of intersections

    -
  • raycast(p, objects, options?): Intersection<Object3D<Object3DEventMap>>[]

  • Runs raycasting for the specified screen-coordinates against the specified +

  • raycast(p, objects, options?): Intersection<Object3D<Object3DEventMap>>[]

  • Runs raycasting for the specified screen-coordinates against the specified list of objects.

    Note for typescript users: the returned Intersection objects can only be properly typed for non-recursive lookups (this is handled by the internal @@ -90,15 +90,15 @@ mouse-cursor. x/y are in range [-1, 1], y is pointing up.

  • objects: Object3D<Object3DEventMap>[]

    list of objects to test

  • Optional options: RaycastOptions & {
        recursive: true;
    }

    raycasting options.

    -

Returns Intersection<Object3D<Object3DEventMap>>[]

  • raycast<T>(p, objects, options?): Intersection<T>[]

  • Type Parameters

    • T extends Object3D<Object3DEventMap>

    Parameters

    Returns Intersection<T>[]

    • requestRedraw

    • requestRedraw(): void

    • Triggers the map to redraw a frame.

      -

      Returns void

    requestStateUpdate

    • requestStateUpdate(): void

    • Triggers the map to update GL state.

      -

      Returns void

    set

    • set(key, value): void

    • Sets a value.

      -

      Parameters

      • key: string
      • value: unknown

      Returns void

    setAnchor

    setMap

    • setMap(map): void

    • Adds the overlay to the map.

      +

    Returns Intersection<Object3D<Object3DEventMap>>[]

  • raycast<T>(p, objects, options?): Intersection<T>[]

  • Type Parameters

    • T extends Object3D<Object3DEventMap>

    Parameters

    Returns Intersection<T>[]

    • requestRedraw

    • requestRedraw(): void

    • Triggers the map to redraw a frame.

      +

      Returns void

    requestStateUpdate

    • requestStateUpdate(): void

    • Triggers the map to update GL state.

      +

      Returns void

    set

    • set(key, value): void

    • Sets a value.

      +

      Parameters

      • key: string
      • value: unknown

      Returns void

    setAnchor

    setMap

    • setMap(map): void

    • Adds the overlay to the map.

      Parameters

      • map: Map

        The map to access the div, model and view state.

        -

      Returns void

    setUpAxis

    • setUpAxis(axis): void

    • Sets the axis to use as "up" in the scene.

      -

      Parameters

      • axis: Vector3 | "Z" | "Y"

      Returns void

    setValues

    • setValues(values?): void

    • Sets a collection of key-value pairs.

      -

      Parameters

      • Optional values: object

      Returns void

    unbind

    • unbind(key): void

    • Removes a binding. Unbinding will set the unbound property to the current +

    Returns void

    setUpAxis

    • setUpAxis(axis): void

    • Sets the axis to use as "up" in the scene.

      +

      Parameters

      • axis: Vector3 | "Z" | "Y"

      Returns void

    setValues

    • setValues(values?): void

    • Sets a collection of key-value pairs.

      +

      Parameters

      • Optional values: object

      Returns void

    unbind

    • unbind(key): void

    • Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

      -

      Parameters

      • key: string

      Returns void

    unbindAll

    • unbindAll(): void

    • Removes all bindings.

      -

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructoranchoranimationModecameraoverlayprojectionMatrixInverseraycasterrendererrotationArrayrotationInversesceneaddListenerbindTogetgetMaplatLngAltitudeToVector3notifyonAddonBeforeDrawonContextLostonContextRestoredonDrawonRemoveonStateUpdateraycastrequestRedrawrequestStateUpdatesetsetAnchorsetMapsetUpAxissetValuesunbindunbindAll
    \ No newline at end of file +

    Parameters

    • key: string

    Returns void

    unbindAll

    • unbindAll(): void

    • Removes all bindings.

      +

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructoranchoranimationModecameraoverlayprojectionMatrixInverseraycasterrendererrotationArrayrotationInversesceneaddListenerbindTogetgetMaplatLngAltitudeToVector3notifyonAddonBeforeDrawonContextLostonContextRestoredonDrawonRemoveonStateUpdateraycastrequestRedrawrequestStateUpdatesetsetAnchorsetMapsetUpAxissetValuesunbindunbindAll
    \ No newline at end of file diff --git a/functions/latLngToVector3Relative.html b/functions/latLngToVector3Relative.html index a87b3275..f7e0151f 100644 --- a/functions/latLngToVector3Relative.html +++ b/functions/latLngToVector3Relative.html @@ -1,3 +1,3 @@ latLngToVector3Relative | @googlemaps/three

    Function latLngToVector3Relative

    • latLngToVector3Relative(point, reference, target?): Vector3

    • Converts latitude and longitude to world space coordinates relative to a reference location with y up.

      -

      Parameters

      • point: LatLngAltitudeLiteral
      • reference: LatLngAltitudeLiteral
      • target: Vector3 = ...

      Returns Vector3

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    • point: LatLngAltitudeLiteral
    • reference: LatLngAltitudeLiteral
    • target: Vector3 = ...

    Returns Vector3

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/latLngToXY.html b/functions/latLngToXY.html index dcf6b00b..a5936e94 100644 --- a/functions/latLngToXY.html +++ b/functions/latLngToXY.html @@ -1,3 +1,3 @@ latLngToXY | @googlemaps/three

    Function latLngToXY

    • latLngToXY(position): number[]

    • Converts WGS84 latitude and longitude to (uncorrected) WebMercator meters. (WGS84 --> WebMercator (EPSG:3857))

      -

      Parameters

      • position: LatLngLiteral

      Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    • position: LatLngLiteral

    Returns number[]

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/toLatLngAltitudeLiteral.html b/functions/toLatLngAltitudeLiteral.html index 1f30d864..82d0cd9a 100644 --- a/functions/toLatLngAltitudeLiteral.html +++ b/functions/toLatLngAltitudeLiteral.html @@ -1,3 +1,3 @@ toLatLngAltitudeLiteral | @googlemaps/three

    Function toLatLngAltitudeLiteral

    • toLatLngAltitudeLiteral(point): google.maps.LatLngAltitudeLiteral

    • Converts any of the supported position formats into the google.maps.LatLngAltitudeLiteral format used for the calculations.

      -

      Parameters

      Returns google.maps.LatLngAltitudeLiteral

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    Returns google.maps.LatLngAltitudeLiteral

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/xyToLatLng.html b/functions/xyToLatLng.html index fcf46a3f..7b1b8a60 100644 --- a/functions/xyToLatLng.html +++ b/functions/xyToLatLng.html @@ -1,3 +1,3 @@ xyToLatLng | @googlemaps/three

    Function xyToLatLng

    • xyToLatLng(p): google.maps.LatLngLiteral

    • Converts WebMercator meters to WGS84 latitude/longitude. (WebMercator (EPSG:3857) --> WGS84)

      -

      Parameters

      • p: number[]

      Returns google.maps.LatLngLiteral

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Parameters

    • p: number[]

    Returns google.maps.LatLngLiteral

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/RaycastOptions.html b/interfaces/RaycastOptions.html index 0eefbda1..8722cbe9 100644 --- a/interfaces/RaycastOptions.html +++ b/interfaces/RaycastOptions.html @@ -1,14 +1,14 @@ -RaycastOptions | @googlemaps/three

    Interface RaycastOptions

    interface RaycastOptions {
        raycasterParameters?: RaycasterParameters;
        recursive?: boolean;
        updateMatrix?: boolean;
    }

    Properties

    raycasterParameters? +RaycastOptions | @googlemaps/three

    Interface RaycastOptions

    interface RaycastOptions {
        raycasterParameters?: RaycasterParameters;
        recursive?: boolean;
        updateMatrix?: boolean;
    }

    Properties

    raycasterParameters? recursive? updateMatrix?

    Properties

    Optional raycasterParameters

    raycasterParameters?: RaycasterParameters

    Additional parameters to pass to the three.js raycaster.

    See

    https://threejs.org/docs/#api/en/core/Raycaster.params

    -

    Optional recursive

    recursive?: boolean

    Set to true to also test children of the specified objects for +

    Optional recursive

    recursive?: boolean

    Set to true to also test children of the specified objects for intersections.

    Default

    false
    -

    Optional updateMatrix

    updateMatrix?: boolean

    Update the inverse-projection-matrix before casting the ray (set this +

    Optional updateMatrix

    updateMatrix?: boolean

    Update the inverse-projection-matrix before casting the ray (set this to false if you need to run multiple raycasts for the same frame).

    Default

    true
    -

    Settings

    Member Visibility

    Theme

    On This Page

    raycasterParametersrecursiveupdateMatrix
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    raycasterParametersrecursiveupdateMatrix
    \ No newline at end of file diff --git a/interfaces/ThreeJSOverlayViewOptions.html b/interfaces/ThreeJSOverlayViewOptions.html index 100f5175..e8932618 100644 --- a/interfaces/ThreeJSOverlayViewOptions.html +++ b/interfaces/ThreeJSOverlayViewOptions.html @@ -1,4 +1,4 @@ -ThreeJSOverlayViewOptions | @googlemaps/three

    Interface ThreeJSOverlayViewOptions

    interface ThreeJSOverlayViewOptions {
        addDefaultLighting?: boolean;
        anchor?: LatLngTypes;
        animationMode?: "always" | "ondemand";
        map?: Map;
        scene?: Scene;
        upAxis?: Vector3 | "Z" | "Y";
    }

    Properties

    addDefaultLighting? +ThreeJSOverlayViewOptions | @googlemaps/three

    Interface ThreeJSOverlayViewOptions

    interface ThreeJSOverlayViewOptions {
        addDefaultLighting?: boolean;
        anchor?: LatLngTypes;
        animationMode?: "always" | "ondemand";
        map?: Map;
        scene?: Scene;
        upAxis?: Vector3 | "Z" | "Y";
    }

    Properties

    addDefaultLighting? anchor? animationMode? map? @@ -7,10 +7,10 @@

    Properties

    Optional addDefaultLighting

    addDefaultLighting?: boolean

    Add default lighting to the scene.

    Default

    true
    -

    Optional anchor

    anchor?: LatLngTypes

    The anchor for the scene.

    +

    Optional anchor

    anchor?: LatLngTypes

    The anchor for the scene.

    Default

    {lat: 0, lng: 0, altitude: 0}
    -

    Optional animationMode

    animationMode?: "always" | "ondemand"

    The animation mode controls when the overlay will redraw, either +

    Optional animationMode

    animationMode?: "always" | "ondemand"

    The animation mode controls when the overlay will redraw, either continuously (always) or on demand (ondemand). When using the on demand mode, the overlay will re-render whenever the map renders (camera movements) or when requestRedraw() is called.

    @@ -19,12 +19,12 @@ requestRedraw() from within the onBeforeRender function to

    Default

    "ondemand"
    -

    Optional map

    map?: Map

    The map the overlay will be added to. +

    Optional map

    map?: Map

    The map the overlay will be added to. Can be set at initialization or by calling setMap(map).

    -

    Optional scene

    scene?: Scene

    The scene object to render in the overlay. If no scene is specified, a +

    Optional scene

    scene?: Scene

    The scene object to render in the overlay. If no scene is specified, a new scene is created and can be accessed via overlay.scene.

    -

    Optional upAxis

    upAxis?: Vector3 | "Z" | "Y"

    The axis pointing up in the scene. Can be specified as "Z", "Y" or a +

    Optional upAxis

    upAxis?: Vector3 | "Z" | "Y"

    The axis pointing up in the scene. Can be specified as "Z", "Y" or a Vector3, in which case the normalized vector will become the up-axis.

    Default

    "Z"
    -

    Settings

    Member Visibility

    Theme

    On This Page

    addDefaultLightinganchoranimationModemapsceneupAxis
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    addDefaultLightinganchoranimationModemapsceneupAxis
    \ No newline at end of file diff --git a/types/LatLngTypes.html b/types/LatLngTypes.html index 72d227dc..be93213a 100644 --- a/types/LatLngTypes.html +++ b/types/LatLngTypes.html @@ -1 +1 @@ -LatLngTypes | @googlemaps/three

    Type alias LatLngTypes

    LatLngTypes: google.maps.LatLngLiteral | google.maps.LatLng | google.maps.LatLngAltitudeLiteral | google.maps.LatLngAltitude

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +LatLngTypes | @googlemaps/three

    Type alias LatLngTypes

    LatLngTypes: google.maps.LatLngLiteral | google.maps.LatLng | google.maps.LatLngAltitudeLiteral | google.maps.LatLngAltitude

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/EARTH_RADIUS.html b/variables/EARTH_RADIUS.html index fe381cfb..7ffcaf5b 100644 --- a/variables/EARTH_RADIUS.html +++ b/variables/EARTH_RADIUS.html @@ -1 +1 @@ -EARTH_RADIUS | @googlemaps/three

    Variable EARTH_RADIUSConst

    EARTH_RADIUS: 6371010 = 6371010.0

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +EARTH_RADIUS | @googlemaps/three

    Variable EARTH_RADIUSConst

    EARTH_RADIUS: 6371010 = 6371010.0

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/variables/WORLD_SIZE.html b/variables/WORLD_SIZE.html index 82568934..ba291821 100644 --- a/variables/WORLD_SIZE.html +++ b/variables/WORLD_SIZE.html @@ -1 +1 @@ -WORLD_SIZE | @googlemaps/three

    Variable WORLD_SIZEConst

    WORLD_SIZE: number = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +WORLD_SIZE | @googlemaps/three

    Variable WORLD_SIZEConst

    WORLD_SIZE: number = ...

    Settings

    Member Visibility

    Theme

    \ No newline at end of file