Marble::LayerInterface Class Reference

#include <LayerInterface.h>

Inheritance diagram for Marble::LayerInterface:

Public Member Functions
virtual	~LayerInterface ()
virtual bool	render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos, GeoSceneLayer *layer)=0
virtual QStringList	renderPosition () const =0
virtual RenderState	renderState () const
virtual QString	runtimeTrace () const
virtual qreal	zValue () const

Detailed Description

Definition at line 26 of file LayerInterface.h.

Constructor & Destructor Documentation

Marble::LayerInterface::~LayerInterface ( )

virtual

Destructor.

Definition at line 16 of file LayerInterface.cpp.

Member Function Documentation

virtual bool Marble::LayerInterface::render ( GeoPainter *  painter, ViewportParams *  viewport, const QString &  renderPos, GeoSceneLayer *  layer  )

pure virtual

Renders the content provided by the layer on the viewport.

Parameters

painter	painter object allowing to paint on the map
viewport	metadata, such as current projection, screen dimension, etc.
renderPos	current render position
layer	deprecated, always zero (NULL)

Returns

true Returns whether the rendering has been successful

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, Marble::AnnotatePlugin, Marble::AbstractFloatItem, Marble::CrosshairsPlugin, Marble::AbstractDataPlugin, Marble::TextureLayer, Marble::EclipsesPlugin, Marble::PositionMarker, Marble::twitterPlugin, Marble::MeasureToolPlugin, Marble::AprsPlugin, Marble::ElevationProfileMarker, Marble::PlacemarkLayer, Marble::InhibitScreensaverPlugin, Marble::SunPlugin, Marble::AtmospherePlugin, Marble::SatellitesPlugin, Marble::RoutingLayer, Marble::PopupLayer, Marble::MyPaintLayer, Marble::GeometryLayer, Marble::GroundLayer, Marble::FogLayer, and Marble::MarbleSplashLayer.

virtual QStringList Marble::LayerInterface::renderPosition ( ) const

pure virtual

Preferred level in the layer stack for the rendering.

Gives a preferred level in the existing layer stack where the render() method of this plugin should get executed. Possible Values: "NONE" "STARS" "BEHIND_TARGET" "SURFACE" "HOVERS_ABOVE_SURFACE" "ATMOSPHERE" "ORBIT" "ALWAYS_ON_TOP" "FLOAT_ITEM" "USER_TOOLS"

Implemented in Marble::StarsPlugin, Marble::AbstractFloatItem, Marble::AbstractDataPlugin, Marble::GraticulePlugin, Marble::AnnotatePlugin, Marble::InhibitScreensaverPlugin, Marble::EclipsesPlugin, Marble::CrosshairsPlugin, Marble::PlacemarkLayer, Marble::VectorTileLayer, Marble::twitterPlugin, Marble::RoutingLayer, Marble::AprsPlugin, Marble::MeasureToolPlugin, Marble::TextureLayer, Marble::PositionMarker, Marble::SatellitesPlugin, Marble::ElevationProfileMarker, Marble::SunPlugin, Marble::PopupLayer, Marble::MyPaintLayer, Marble::AtmospherePlugin, Marble::GeometryLayer, Marble::GroundLayer, Marble::FogLayer, and Marble::MarbleSplashLayer.

RenderState Marble::LayerInterface::renderState ( ) const

virtual

Reimplemented in Marble::RenderPlugin, DeclarativeDataPlugin, Marble::TextureLayer, Marble::PlacemarkLayer, Marble::RoutingLayer, Marble::VectorTileLayer, Marble::PopupLayer, Marble::GeometryLayer, Marble::GroundLayer, Marble::FogLayer, and Marble::MarbleSplashLayer.

Definition at line 27 of file LayerInterface.cpp.

QString Marble::LayerInterface::runtimeTrace ( ) const

virtual

Returns a debug line for perfo/tracing issues.

Reimplemented in Marble::RenderPlugin, Marble::AnnotatePlugin, Marble::TextureLayer, Marble::PlacemarkLayer, Marble::PopupLayer, Marble::GeometryLayer, Marble::GroundLayer, Marble::MarbleSplashLayer, and Marble::FogLayer.

Definition at line 32 of file LayerInterface.cpp.

qreal Marble::LayerInterface::zValue ( ) const

virtual

Returns the z value of the layer (default: 0.0).

If two layers are painted at the same render position, the one with the higher z value is painted on top. If both have the same z value, their paint order is undefined.

Reimplemented in Marble::GraticulePlugin, Marble::PositionMarker, Marble::PlacemarkLayer, Marble::ElevationProfileFloatItem, Marble::RoutingLayer, Marble::AtmospherePlugin, Marble::ElevationProfileMarker, Marble::PopupLayer, and Marble::GroundLayer.

Definition at line 22 of file LayerInterface.cpp.

---

The documentation for this class was generated from the following files:

• LayerInterface.h
• LayerInterface.cpp