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

Implements

  • WebGLOverlayView

Constructors

Implements

  • WebGLOverlayView

Constructors

Properties

Constructors

Properties

anchor: LatLngAltitudeLiteral

The anchor for the scene.

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

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

Constructors

Properties

anchor: LatLngAltitudeLiteral

The anchor for the scene.

+
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

-
camera: PerspectiveCamera
overlay: WebGLOverlayView
projectionMatrixInverse: Matrix4 = ...
raycaster: Raycaster = ...
renderer: WebGLRenderer
rotationArray: Float32Array = ...
rotationInverse: Quaternion = ...
scene: Scene

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

camera: PerspectiveCamera
overlay: WebGLOverlayView
projectionMatrixInverse: Matrix4 = ...
raycaster: Raycaster = ...
renderer: WebGLRenderer
rotationArray: Float32Array = ...
rotationInverse: Quaternion = ...
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

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

Methods

  • 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

  • Binds a View to a Model.

    -

    Parameters

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

    Returns void

  • Gets a value.

    -

    Parameters

    • key: string

    Returns any

  • Returns the map the overlay is added to.

    -

    Returns Map

  • 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

  • Binds a View to a Model.

    +

    Parameters

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

    Returns void

  • Gets a value.

    +

    Parameters

    • key: string

    Returns any

  • Returns the map the overlay is added to.

    +

    Returns Map

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

    -

    Parameters

    Returns Vector3

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

    Parameters

    Returns Vector3

  • 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

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

    Parameters

    • key: string

    Returns 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

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

    Returns void

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

    -

    Returns void

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

    Returns 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

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

    Returns 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

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

Returns void

Returns void

Returns Intersection<Object3D<Object3DEventMap>>[]

  • Type Parameters

    • T extends Object3D<Object3DEventMap>

    Parameters

    Returns Intersection<T>[]

  • Returns Intersection<Object3D<Object3DEventMap>>[]

  • Type Parameters

    • T extends Object3D<Object3DEventMap>

    Parameters

    Returns Intersection<T>[]

  • Returns void

    \ No newline at end of file +

    Parameters

    Returns void

    \ 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

    • 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

    \ No newline at end of file +

    Parameters

    Returns Vector3

    \ 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

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

      -

      Parameters

      • position: LatLngLiteral

      Returns number[]

    \ No newline at end of file +

    Parameters

    Returns number[]

    \ 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

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

      -

      Parameters

      Returns google.maps.LatLngAltitudeLiteral

    \ No newline at end of file +

    Parameters

    Returns google.maps.LatLngAltitudeLiteral

    \ 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

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

      -

      Parameters

      • p: number[]

      Returns google.maps.LatLngLiteral

    \ No newline at end of file +

    Parameters

    Returns google.maps.LatLngLiteral

    \ 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?: RaycasterParameters

    Additional parameters to pass to the three.js raycaster.

    recursive?: boolean

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

    recursive?: boolean

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

    Default

    false
     
    -
    updateMatrix?: boolean

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

    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
     
    -
    \ No newline at end of file +
    \ 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

    Properties

    addDefaultLighting?: boolean

    Add default lighting to the scene.

    Default

    true
     
    -
    anchor?: LatLngTypes

    The anchor for the scene.

    +
    anchor?: LatLngTypes

    The anchor for the scene.

    Default

    {lat: 0, lng: 0, altitude: 0}
     
    -
    animationMode?: "always" | "ondemand"

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

    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"
     
    -
    map?: Map

    The map the overlay will be added to. +

    map?: Map

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

    -
    scene?: Scene

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

    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.

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

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

    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"
     
    -
    \ No newline at end of file +
    \ 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
    \ 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
    \ 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
    \ No newline at end of file +EARTH_RADIUS | @googlemaps/three

    Variable EARTH_RADIUSConst

    EARTH_RADIUS: 6371010 = 6371010.0
    \ 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 = ...
    \ No newline at end of file +WORLD_SIZE | @googlemaps/three

    Variable WORLD_SIZEConst

    WORLD_SIZE: number = ...
    \ No newline at end of file