Mapspace API Reference

Class: RenderLoop

RenderLoop

A RenderLoop causes a Mapspace.street.threejs.SceneManager to be rendered on the next frame when it reports that its contents are invalid. The loop may be manually started/stopped and begins in the stopped state.

new RenderLoop(sceneManager)

Parameters:
Name Type Description
sceneManager Mapspace.street.threejs.SceneManager

SceneManager.
Source:
mapspace-street/renderloop.js
Fires:
  • ol.events.Event#event:afterrender
  • ol.events.Event#event:beforerender

Extends

  • ol.Object

Members

rendering :boolean

Whether the loop is currently rendering.

Source:
mapspace-street/renderloop.js

running :boolean

Whether the loop is running.

Source:
mapspace-street/renderloop.js

sceneManager :Mapspace.street.threejs.SceneManager

The SceneManager wrapped by the loop.

Source:
mapspace-street/renderloop.js

screenshot :DOMString

The screenshot codified as a data URI.

Source:
mapspace-street/renderloop.js

takeScreenshot :boolean

If take screenshot in each render or not.

Source:
mapspace-street/renderloop.js

Methods

changeBrightness(brightness)

Changes brightness pass.

Parameters:
Name Type Description
brightness number

Brightness. Value range in [-100,100].
Source:
mapspace-street/renderloop.js

changeContrast(contrast)

Changes contrast pass.

Parameters:
Name Type Description
contrast number

Contrast. Value range in [-100,100].
Source:
mapspace-street/renderloop.js

getSceneManager()

Get the underlying SceneManager.

Source:
mapspace-street/renderloop.js
Returns:
Type
Mapspace.street.threejs.SceneManager

loop()

This is the function that will be called when a requestAnimationFrame is Executed and does the final rendering in the SceneManager.

Source:
mapspace-street/renderloop.js

render()

Requests a new render if it not currently rendering.

Source:
mapspace-street/renderloop.js

renderOnNextFrame()

Requests a render on the next frame, even if the stage contents remain valid. Does nothing if the loop is stopped.

Source:
mapspace-street/renderloop.js

start()

Starts the render loop.

Source:
mapspace-street/renderloop.js

stop()

Stops the render loop.

Source:
mapspace-street/renderloop.js