Class: RenderEngine

H .map .render.RenderEngine

new H.map.render.RenderEngine (viewPort, viewModel, dataModel, options) abstract

This is an abstract class representing a render engine. Render engines are used to render the geographical position from a view model on the screen (viewport element). The rendered result may be different for different engines, because every engine uses its own capabilities and specific implementation to present the current view model data in best possible way. For example, P2D engine creates a two-dimensional flat map composed of raster tiles, while WEBGL engine can render 3D scene based on vector tiles.

A RenderEngine is responsible for managing the rendering loop as well as for synchronizing rendered data with the view model and the data model. It manages what is rendered inside the current viewport and how.

Name	Type	Description
`viewPort`	H.map.ViewPort	An object representing the map viewport
`viewModel`	H.map.ViewModel	An object representing a view of the map
`dataModel`	H.map.DataModel	An object encapsulating the data to be rendered on the map (layers and objects)
`options`	H.map.render.RenderEngine.Options	An object containing the render engine initialization options

Extends

H.util.EventTarget

Implements

H.util.animation.IAnimatable

Members

H.map.render.RenderEngine.InteractionModifiers static

This object defines the modifiers to use for H.map.ViewPort#startInteraction.

Properties:

Name	Description
`ZOOM`	changes zoom level during the interaction
`HEADING`	changes heading angle during the interaction
`TILT`	changes tilt angle during the interaction
`INCLINE`	changes incline angle during the interaction
`COORD`	changes map center during the interaction

Methods

addEventListener (type, handler, opt_capture, opt_scope) inherited

This method adds a listener for a specific event.

Note that to prevent potential memory leaks, you must either call removeEventListener or dispose on the given object when you no longer need it.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	An event handler function
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function

addOnDisposeCallback (callback, opt_scope) inherited

This method adds a callback which is triggered when the EventTarget object is being disposed.

Name	Type	Description
`callback`	function	The callback function.
`opt_scope`	Object	optional An optional scope for the callback function

dispatchEvent (evt) inherited

This method dispatches an event on the EventTarget object.

Name	Type	Description
`evt`	H.util.Event \| string	An object representing the event or a string with the event name

dispose () inherited

This method removes listeners from the given object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

removeEventListener (type, handler, opt_capture, opt_scope) inherited

This method removes a previously added listener from the EventTarget instance.

Name	Type	Description
`type`	string	The name of the event
`handler`	function	A previously added event handler
`opt_capture`	boolean	optional `true` indicates that the method should listen in the capture phase (bubble otherwise)
`opt_scope`	Object	optional An object defining the scope for the handler function

Type Definitions

H.map.render.RenderEngine.Options Object

Options which may be used to initialize new RenderEngine instance.

Properties:

Name	Type	Description
`pixelRatio`	number	The pixelRatio to use for over-sampling in cases of high-resolution displays

Events

render

Fired when one of the layers or the engine (all layers) has been rendered completely. The event target references either the completed layer or the render engine itself.

Type:

H.util.Event