Maps API for JavaScript Developer's Guide

H.map.render.RenderEngine

Class Summary

Extends: H.util.EventTarget

Abstract RenderEngine class. Render engines are used to render geographical position set on the view model to the actual screen (viewport element). The rendered result may be different for different engines, since every engine uses its onw capabilities and specific implementation to present the current view model data in best possible way. In example for 2D engines user will se mostly 2 dimensional flat map presented by tiles, on the other hand 3D engines like panorama will display the same coordinates as a 'street view'. In other words 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 and how gets rendered inside the current viewport.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

addEventListener (type, handler, opt_capture, opt_scope)

This method allows to listen for specific event triggered by the object. Keep in mind, that you must removeEventListener manually or dispose an object when you no longer need it. Otherwise memory leak is possible.

removeEventListener (type, handler, opt_capture, opt_scope)

This method will removed previously added listener from the event target

dispatchEvent (evt)

This method will dispatch event on the event target object

dispose ()

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

addOnDisposeCallback (callback, opt_scope)

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

Events Summary

Table 2. Events
Events

render : {H.util.Event}

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

Class Description

Abstract RenderEngine class. Render engines are used to render geographical position set on the view model to the actual screen (viewport element). The rendered result may be different for different engines, since every engine uses its onw capabilities and specific implementation to present the current view model data in best possible way. In example for 2D engines user will se mostly 2 dimensional flat map presented by tiles, on the other hand 3D engines like panorama will display the same coordinates as a 'street view'. In other words 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 and how gets rendered inside the current viewport.

Constructor Details

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

Parameters:
 
viewPort:
{H.map.ViewPort}
 
viewModel:
{H.map.ViewModel}
 
dataModel:
{H.map.DataModel}
 
options:
{H.map.render.RenderEngine.Options}
 

Method Details

addEventListener (type, handler, opt_capture, opt_scope)

This method allows to listen for specific event triggered by the object. Keep in mind, that you must removeEventListener manually or dispose an object when you no longer need it. Otherwise memory leak is possible.

Parameters:
 
type:
{string}
 
name of event
handler:
{!Function}
 
event handler function
opt_capture:
{boolean=} [optional]
 
if set to true will listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
scope for the handler function

removeEventListener (type, handler, opt_capture, opt_scope)

This method will removed previously added listener from the event target

Parameters:
 
type:
{string}
 
name of event
handler:
{!Function}
 
previously added event handler
opt_capture:
{boolean=} [optional]
 
if set to true will listen in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
scope for the handler function

dispatchEvent (evt)

This method will dispatch event on the event target object

Parameters:
 
evt:
{(H.util.Event | string)}
 
event object or event name

dispose ()

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

addOnDisposeCallback (callback, opt_scope)

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

Parameters:
 
callback:
{!Function}
 
The callback function.
opt_scope:
{Object=} [optional]
 
An optional scope to call the callback in.

Event Details

render: {H.util.Event}

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

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.