Class ThreeJSOverlayView

constructor

• new ThreeJSOverlayView(options?): ThreeJSOverlayView

• Parameters

  • options: ThreeJSOverlayViewOptions = {}

  Returns ThreeJSOverlayView

animationMode

Readonly scene

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 coordinates while taking the origin and orientation into account.

  Parameters

  • position: LatLngTypes
  • target: Vector3 = ...

  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 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 drawn.

  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 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 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 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 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 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 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 signature below).

  Parameters

  • p: Vector2

    normalized screenspace coordinates of the 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

  • p: Vector2
  • objects: T[]
  • Optional options: Omit<RaycastOptions, "recursive"> | RaycastOptions & {
        recursive: false;
    }

  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

• setAnchor(anchor): void

• Sets the anchor-point.

  Parameters

  • anchor: LatLngTypes

  Returns void

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 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