Class: RenderEngine

H.map.render.webgl.RenderEngine

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

This class is an implementation of WebGL render engine. It presents a geo position (from a view model) in a 3D scene, where all layers are rendered in the order in which they are provided.

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

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.

geoToMeters (geoPoint)Object

This method retrieves the projected world coordinates corresponding to the geographical coordinates supplied by the caller.

Name Type Description
geoPoint H.geo.IPoint

An object containing the geographical coordinates.
Returns:
Type Description
Object An object representing the results of the conversion to the world coordinates.

getAnimationDuration () Deprecated : since 3.1.24.0

This method was previously retrieving the current animation duration. Now it's deprecated and always returns undefined.

getAnimationEase () Deprecated : since 3.1.24.0

This method was previously retrieving the current animation easing. Now it's deprecated and always returns undefined.

metersToGeo (point)H.geo.IPoint

This method retrieves the geographical coordinates corresponding to the projected world coordinates supplied by the caller.

Name Type Description
point Object

An object defining a location in meters.
Returns:
Type Description
H.geo.IPoint An object representing the results of conversion to a geographical location.

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

resetAnimationDefaults () Deprecated : since 3.1.24.0

This method was previously used to reset animation settings on the render engine to defaults. Now it's deprecated and doesn't change animation behavior.

setAnimationDuration () Deprecated : since 3.1.24.0

This method was previously setting the duration for all animations run by the render engine. Now it's deprecated and doesn't change animation behavior.

setAnimationEase () Deprecated : since 3.1.24.0

This method was previously setting a value indicating the easing to apply to animations run by the render engine. Now it's deprecated and doesn't change animation behavior.

Type Definitions

H.map.render.webgl.RenderEngine.Options Object

Options that can be used to initialize a new instance of the RenderEngine.

Properties:
Name Type Argument Description
renderBaseBackground Object <optional>

Object describes how many cached zoom levels should be used as a base map background while base map tiles are
pixelRatio number

The pixelRatio to use for over-sampling in cases of high-resolution displays
enableSubpixelRendering boolean <optional>

Events

render inherited

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: