BlankRenderEngine

Since: BlackBerry 10.0.0

#include <bb/cascades/maps/BlankRenderEngine>

To link against this class, add the following line to your .pro file: LIBS += -lbbcascadesmaps

An empty render engine, which will be used when no other engine can be found.


Overview

Inheritance

bb::cascades::maps::RenderEngine
bb::cascades::maps::BlankRenderEngine

Public Functions Index

BlankRenderEngine (QObject *parent=0)
virtual ~BlankRenderEngine ()
virtual bb::platform::geo::BoundingBoxcalculateBoundingBox (const ViewProperties &view) const
virtual bb::cascades::maps::RenderEngineInfocharacteristics () const
virtual intcoveragePriority () const
virtual boolcoverageSupported (const bb::cascades::maps::ViewProperties &region) const
virtual QStringelementIdAt (const QPoint &windowCoord) const
virtual bb::ImageDatagenerateMapImage () const
virtual voidinitialize (bb::cascades::maps::RenderEngineConfiguration config)
virtual boolisBaseMapVisible () const
virtual bb::cascades::maps::RenderEngine *newInstance () const
virtual voidrender ()
virtual voidsetBaseMapVisible (bool visible)
virtual voidsetMapData (MapData *data)
virtual voidsetViewport (const bb::cascades::maps::ViewProperties &view)
virtual voidteardown ()
virtual bb::platform::geo::PointwindowToWorld (const QPoint &windowCoord) const
virtual QPointworldToWindow (const bb::platform::geo::Point &worldCoord) const
boolisInlineTrafficAvailable ()Inherited
boolisInlineTrafficEnabled ()Inherited
RenderEngine (QObject *parent=0)Inherited
voidsetInlineTrafficAvailable (bool available)Inherited
voidsetInlineTrafficEnabled (bool enabled)Inherited

Signals Index

Only has inherited signals

voidcoverageUnavailable ()Inherited
voidinlineTrafficAvailableChanged (bool available)Inherited
voidinlineTrafficEnabledChanged (bool enabled)Inherited
voidrenderCompleted ()Inherited

Public Functions

BlankRenderEngine (

Basic constructor.

Parameters
parent

The parent object to this object.

Since:

BlackBerry 10.0.0

virtual~BlankRenderEngine ()

Destructor.

virtualbb::platform::geo::BoundingBox calculateBoundingBox (

Calculates a new bounding box based on the view properties provided.

Parameters
view

The properties of the view to base the calculation on.

Return:

A bounding box that matches the limits of the view.

Since:

BlackBerry 10.0.0

virtualbb::cascades::maps::RenderEngineInfo characteristics ()

Gets the characteristics of this engine.

Return:

The information concerning the characteristics of this engine.

Since:

BlackBerry 10.0.0

virtual int coveragePriority ()

Indicates the priority for which this engine should be used when two engines have coverage over the same area.

Thus, if render engine A and B both have coverage over the current viewport, the render engine with the higher priority will be used.

Current priorities include:
  • 5: Reserved for Application-provided plug-in

  • 4: 3D System Render Engine

  • 3: 2D System Render Engine

  • 0: Blank Render Engine (no memory consumption)

Return:

The priority for this render engine. A higher number equals a higher priority. Numbers range from 0 to 5. 5 indicates an RE should absolutely be used, while 3 indicates a "normal" priority.

Since:

BlackBerry 10.0.0

virtual bool coverageSupported (

Indicates whether this render engine has code coverage for the given region.

Note: Important factors to be considered are center, altitude and bounding box.

Parameters
region

The region in question.

Return:

true if this engine has map coverage for the entire region, false if partial coverage or no coverage.

Since:

BlackBerry 10.0.0

virtualQString elementIdAt (

Gets the element ID of the interactable element at the given window coordinates.

Parameters
windowCoord

the location of the point of interest.

Return:

The ID of the element available, or an empty string if no element exists.

Since:

BlackBerry 10.0.0

virtualbb::ImageData generateMapImage ()

Converts the current map into an image.

Return:

The viewport's content as an image.

Since:

BlackBerry 10.0.0

virtual void initialize (

Initializes the engine.

Since:

BlackBerry 10.0.0

virtual bool isBaseMapVisible ()

Indicates whether base map data is included in the rendered output.

Base map data includes items such as ground information, roads, and so on.

Return:

true if the base map is included.

Since:

BlackBerry 10.0.0

virtualbb::cascades::maps::RenderEngine * newInstance ()

Creates a new instance of this render engine.

This factory method is only used through the plug-in system.

Return:

The new instance of the RenderEngine, never null.

Since:

BlackBerry 10.0.0

virtual void render ()

Initiates a render cycle using the location information previously provided.

Note: This operation will not be called again until it has returned. Thus, there might be a backlog of render requests. It is important that this operation return in a timely fashion so that other messages in the messaging queue can be delivered.

Since:

BlackBerry 10.0.0

virtual void setBaseMapVisible (
  • boolvisible)

Sets whether or not the base map should be included in the rendered output.

Parameters
visible

true if the base map should be included.

Since:

BlackBerry 10.0.0

virtual void setMapData (

Gives the render engine the mapping data container holding non-atlas data.

Parameters
data

The container for mapping data. This parameter is owned by the parent MapView instance.

Since:

BlackBerry 10.0.0

virtual void setViewport (

Changes the properties of the view.

This call is not an explicit request to initiate a new render. To initiate a new render use RenderEngine::render.

This is a blocking call (synchronous). See the class level comment titled "Communication Between MapView and RenderEngine".

Parameters
view

The new view properties.

Since:

BlackBerry 10.0.0

virtual void teardown ()

Provides an opportunity for the engine to perform any shutdown work.

Since:

BlackBerry 10.0.0

virtualbb::platform::geo::Point windowToWorld (

Converts the screen coordinates to world coordinates.

This is a blocking call (synchronous). See the class level comment titled "Communication Between MapView and RenderEngine".

Parameters
windowCoord

The coordinates within the viewport's window to convert.

Return:

The coordinates representing the window's coordinates.

Since:

BlackBerry 10.0.0

virtualQPoint worldToWindow (

Converts a world coordinate into a screen/window coordinate.

This is a blocking call.

Parameters
worldCoord

The world (lat/lon) coordinates to convert.

Return:

The window coordinates representing the world coordinates. The returned coordinates may not be within the current window's view.

Since:

BlackBerry 10.0.0

bool isInlineTrafficAvailable ()Inherited

Indicates whether there is inline traffic available for the current map view.

Return:

true if traffic data is available for the current view, false if no traffic data is available.

Since:

BlackBerry 10.2.0

bool isInlineTrafficEnabled ()Inherited

Indicates whether inline traffic has been enabled within this RenderEngine.

Return:

true to enable, false to disable inline traffic.

Since:

BlackBerry 10.2.0

RenderEngine (Inherited

Base Constructor.

Parameters
parent

The parent object to this object.

Since:

BlackBerry 10.0.0

void setInlineTrafficAvailable (
  • boolavailable)
Inherited

Sets the flag indicating if inline traffic is available within the current map view.

It is the RenderEngine's responsibility to call this operation whenever the availability state changes.

Parameters
available

true if traffic data is available for the current view, false if no traffic data is available.

Since:

BlackBerry 10.2.0

void setInlineTrafficEnabled (
  • boolenabled)
Inherited

Enables the inclusion of inline traffic within the map.

Note: If the render engine doesn't support inline traffic, setting this value will have no effect.

Parameters
enabled

true to enable, false to disable inline traffic.

Since:

BlackBerry 10.2.0

Signals

(Only has inherited signals)

void coverageUnavailable ()Inherited

Emitted when the RenderEngine cannot fully render the current map viewing area.

Since:

BlackBerry 10.0.0

void inlineTrafficAvailableChanged (
  • boolavailable)
Inherited

Emitted when the "inline traffic available" state has changed.

Parameters
available

The availability state for the inline traffic flag.

Since:

BlackBerry 10.2.0

void inlineTrafficEnabledChanged (
  • boolenabled)
Inherited

Emitted when the "enable inline traffic" state has changed.

Parameters
enabled

The new state for inline traffic being enabled / disabled.

Since:

BlackBerry 10.2.0

void renderCompleted ()Inherited

Indicates to observers that a render cycle has been completed.

Since:

BlackBerry 10.0.0

Last modified: 2014-03-13

comments powered by Disqus