Marble::RenderPluginInterface Class Reference

#include <RenderPluginInterface.h>

Inheritance diagram for Marble::RenderPluginInterface:

Public Member Functions
virtual	~RenderPluginInterface ()
virtual QStringList	backendTypes () const =0
virtual void	initialize ()=0
virtual bool	isInitialized () const =0
virtual QString	renderPolicy () const =0
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
virtual QString	aboutDataText () const
virtual QString	copyrightYears () const =0
virtual QString	description () const =0
virtual QIcon	icon () const =0
virtual QString	name () const =0
virtual QString	nameId () const =0
virtual QList< PluginAuthor >	pluginAuthors () const =0
virtual QString	version () const =0
Public Member Functions inherited from Marble::LayerInterface
virtual	~LayerInterface ()
virtual bool	render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos, GeoSceneLayer *layer)=0
virtual QStringList	renderPosition () const =0
virtual QString	runtimeTrace () const
virtual qreal	zValue () const

Detailed Description

The class that specifies the Marble layer interface of a plugin.

Definition at line 30 of file RenderPluginInterface.h.

Constructor & Destructor Documentation

Marble::RenderPluginInterface::~RenderPluginInterface ( )

virtual

Definition at line 16 of file RenderPluginInterface.cpp.

Member Function Documentation

virtual QStringList Marble::RenderPluginInterface::backendTypes ( ) const

pure virtual

Returns the name(s) of the backend that the plugin can render This method should return the name of the backend that the plugin can render.

The string has to be the same one that is given for the attribute in the layer element of the DGML file that backend is able to process. Examples to replace available default backends would be "vector" or "texture". To provide a completely new kind of functionality please choose your own unique string.

Implemented in Marble::StarsPlugin, Marble::GraticulePlugin, Marble::AbstractDataPlugin, Marble::ElevationProfileFloatItem, Marble::FITemplateFloatItem, Marble::AnnotatePlugin, Marble::CrosshairsPlugin, Marble::NavigationFloatItem, Marble::OverviewMap, Marble::PositionMarker, Marble::twitterPlugin, Marble::AprsPlugin, Marble::MeasureToolPlugin, Marble::OpenCachingComPlugin, Marble::GpsInfo, Marble::Speedometer, Marble::CompassFloatItem, Marble::SatellitesPlugin, Marble::MapScaleFloatItem, Marble::FileViewFloatItem, Marble::License, Marble::ElevationProfileMarker, Marble::InhibitScreensaverPlugin, Marble::ProgressFloatItem, Marble::RoutingPlugin, Marble::SunPlugin, and Marble::AtmospherePlugin.

virtual void Marble::RenderPluginInterface::initialize ( )

pure virtual

Implemented in Marble::StarsPlugin, DeclarativeDataPlugin, Marble::GraticulePlugin, Marble::CrosshairsPlugin, Marble::ElevationProfileFloatItem, Marble::AnnotatePlugin, Marble::FITemplateFloatItem, Marble::OverviewMap, Marble::PositionMarker, Marble::NavigationFloatItem, Marble::twitterPlugin, Marble::AprsPlugin, Marble::GpsInfo, Marble::MeasureToolPlugin, Marble::Speedometer, Marble::ElevationProfileMarker, Marble::CompassFloatItem, Marble::MapScaleFloatItem, Marble::SunPlugin, Marble::ProgressFloatItem, Marble::AtmospherePlugin, Marble::SatellitesPlugin, Marble::FileViewFloatItem, Marble::License, Marble::PhotoPlugin, Marble::OpenCachingComPlugin, Marble::OpenCachingPlugin, Marble::WeatherPlugin, Marble::WikipediaPlugin, Marble::InhibitScreensaverPlugin, Marble::EarthquakePlugin, Marble::RoutingPlugin, Marble::OpenDesktopPlugin, Marble::PanoramioPlugin, Marble::FoursquarePlugin, and Marble::PostalCodePlugin.

virtual bool Marble::RenderPluginInterface::isInitialized ( ) const

pure virtual

Implemented in Marble::StarsPlugin, DeclarativeDataPlugin, Marble::GraticulePlugin, Marble::CrosshairsPlugin, Marble::ElevationProfileFloatItem, Marble::AnnotatePlugin, Marble::FITemplateFloatItem, Marble::OverviewMap, Marble::PositionMarker, Marble::NavigationFloatItem, Marble::twitterPlugin, Marble::GpsInfo, Marble::MeasureToolPlugin, Marble::Speedometer, Marble::AprsPlugin, Marble::ElevationProfileMarker, Marble::CompassFloatItem, Marble::MapScaleFloatItem, Marble::SunPlugin, Marble::ProgressFloatItem, Marble::AtmospherePlugin, Marble::AbstractDataPlugin, Marble::SatellitesPlugin, Marble::FileViewFloatItem, Marble::License, Marble::OpenCachingComPlugin, Marble::OpenCachingPlugin, Marble::InhibitScreensaverPlugin, and Marble::RoutingPlugin.

virtual QString Marble::RenderPluginInterface::renderPolicy ( ) const

pure virtual

Return how the plugin settings should be used.

FIXME: Document this Possible Values: "ALWAYS" – the plugin renders at the preferred position no matter what got specified in the DGML file. "SPECIFIED" – renders only in case it got specified in the DGML file. "SPECIFIED_ALWAYS" – In case it got specified in the DGML file render according to the specification otherwise choose the preferred position

Implemented in Marble::StarsPlugin, Marble::AbstractFloatItem, Marble::AbstractDataPlugin, Marble::GraticulePlugin, Marble::InhibitScreensaverPlugin, Marble::AnnotatePlugin, Marble::CrosshairsPlugin, Marble::twitterPlugin, Marble::AprsPlugin, Marble::MeasureToolPlugin, Marble::PositionMarker, Marble::SatellitesPlugin, Marble::ElevationProfileMarker, Marble::SunPlugin, and Marble::AtmospherePlugin.

---

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

• RenderPluginInterface.h
• RenderPluginInterface.cpp