Marble::GraticulePlugin Class Reference

#include <GraticulePlugin.h>

Inheritance diagram for Marble::GraticulePlugin:

Public Slots
void	equatorGetColor ()
void	gridGetColor ()
void	readSettings ()
void	tropicsGetColor ()
void	writeSettings ()
Public Slots inherited from Marble::RenderPlugin
QAction *	action () const
void	restoreDefaultSettings ()
void	setEnabled (bool enabled)
bool	setSetting (const QString &key, const QVariant &value)
QVariant	setting (const QString &key)
QStringList	settingKeys ()
void	setUserCheckable (bool isUserCheckable)
void	setVisible (bool visible)

Public Member Functions
	GraticulePlugin ()
	GraticulePlugin (const MarbleModel *marbleModel)
QStringList	backendTypes () const
QDialog *	configDialog ()
QString	copyrightYears () const
QString	description () const
QString	guiString () const
QIcon	icon () const
void	initialize ()
bool	isInitialized () const
QString	name () const
QString	nameId () const
QList< PluginAuthor >	pluginAuthors () const
virtual bool	render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos, GeoSceneLayer *layer=0)
QString	renderPolicy () const
QStringList	renderPosition () const
virtual void	setSettings (const QHash< QString, QVariant > &settings)
virtual QHash< QString, QVariant >	settings () const
QString	version () const
virtual qreal	zValue () const
Public Member Functions inherited from Marble::RenderPlugin
	RenderPlugin (const MarbleModel *marbleModel)
virtual	~RenderPlugin ()
virtual const QList < QActionGroup * > *	actionGroups () const
bool	enabled () const
bool	isUserCheckable () const
const MarbleModel *	marbleModel () const
virtual RenderPlugin *	newInstance (const MarbleModel *marbleModel) const =0
virtual RenderType	renderType () const
virtual QString	runtimeTrace () const
virtual const QList < QActionGroup * > *	toolbarActionGroups () const
bool	visible () const
Public Member Functions inherited from Marble::RenderPluginInterface
virtual	~RenderPluginInterface ()
Public Member Functions inherited from Marble::PluginInterface
virtual	~PluginInterface ()
virtual QString	aboutDataText () const
Public Member Functions inherited from Marble::LayerInterface
virtual	~LayerInterface ()
Public Member Functions inherited from Marble::DialogConfigurationInterface
virtual	~DialogConfigurationInterface ()

Additional Inherited Members
Public Types inherited from Marble::RenderPlugin
enum	RenderType {   UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType,   ThemeRenderType }
Signals inherited from Marble::RenderPlugin
void	actionGroupsChanged ()
void	enabledChanged (bool enable)
void	repaintNeeded (QRegion dirtyRegion=QRegion())
void	settingsChanged (QString nameId)
void	userCheckableChanged (bool isUserCheckable)
void	visibilityChanged (bool visible, const QString &nameId)
Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject *, QEvent *)
Properties inherited from Marble::RenderPlugin
QString	description
bool	enabled
QString	name
QString	nameId
bool	userCheckable
QString	version
bool	visible

Detailed Description

A plugin that creates a coordinate grid on top of the map.

Unlike in all other classes we are using degree by default in this class. This choice was made due to the fact that all common coordinate grids focus fully on the degree system.

Definition at line 54 of file GraticulePlugin.h.

Constructor & Destructor Documentation

Marble::GraticulePlugin::GraticulePlugin

(

)

Definition at line 41 of file GraticulePlugin.cpp.

Marble::GraticulePlugin::GraticulePlugin ( const MarbleModel *  marbleModel )

explicit

Definition at line 48 of file GraticulePlugin.cpp.

Member Function Documentation

QStringList Marble::GraticulePlugin::backendTypes ( ) const

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.

Implements Marble::RenderPluginInterface.

Definition at line 61 of file GraticulePlugin.cpp.

QDialog * Marble::GraticulePlugin::configDialog ( )

virtual

Returns a pointer to the configuration dialog of the plugin.

Returns

: Pointer to the configuration dialog, which must be non-zero.

Implements Marble::DialogConfigurationInterface.

Definition at line 131 of file GraticulePlugin.cpp.

QString Marble::GraticulePlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 101 of file GraticulePlugin.cpp.

QString Marble::GraticulePlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 96 of file GraticulePlugin.cpp.

void Marble::GraticulePlugin::equatorGetColor ( )

slot

Definition at line 238 of file GraticulePlugin.cpp.

void Marble::GraticulePlugin::gridGetColor ( )

slot

Definition at line 216 of file GraticulePlugin.cpp.

QString Marble::GraticulePlugin::guiString ( ) const

virtual

String that should be displayed in GUI.

Using a "&" you can suggest key shortcuts

Example: "&Stars"

Returns

string for gui usage

Implements Marble::RenderPlugin.

Definition at line 81 of file GraticulePlugin.cpp.

QIcon Marble::GraticulePlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 112 of file GraticulePlugin.cpp.

void Marble::GraticulePlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 117 of file GraticulePlugin.cpp.

bool Marble::GraticulePlugin::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 126 of file GraticulePlugin.cpp.

QString Marble::GraticulePlugin::name ( ) const

virtual

Returns the user-visible name of the plugin.

The user-visible name should be context free, i.e. the name should provide enough information as to what the plugin is about in the context of Marble.

Example: "Starry Sky Background", "OpenRouteService Routing"

Implements Marble::PluginInterface.

Definition at line 76 of file GraticulePlugin.cpp.

QString Marble::GraticulePlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 86 of file GraticulePlugin.cpp.

QList< PluginAuthor > Marble::GraticulePlugin::pluginAuthors ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 106 of file GraticulePlugin.cpp.

void Marble::GraticulePlugin::readSettings ( )

slot

Definition at line 195 of file GraticulePlugin.cpp.

bool Marble::GraticulePlugin::render ( GeoPainter *  painter, ViewportParams *  viewport, const QString &  renderPos, GeoSceneLayer *  layer = 0  )

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

Implements Marble::LayerInterface.

Definition at line 260 of file GraticulePlugin.cpp.

QString Marble::GraticulePlugin::renderPolicy ( ) const

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

Implements Marble::RenderPluginInterface.

Definition at line 66 of file GraticulePlugin.cpp.

QStringList Marble::GraticulePlugin::renderPosition ( ) const

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"

Implements Marble::LayerInterface.

Definition at line 71 of file GraticulePlugin.cpp.

void Marble::GraticulePlugin::setSettings ( const QHash< QString, QVariant > &  settings )

virtual

Set the settings of the plugin.

Usually this is called at startup to restore saved settings.

Parameters

new	plugin's settings

See also

settings

Reimplemented from Marble::RenderPlugin.

Definition at line 174 of file GraticulePlugin.cpp.

QHash< QString, QVariant > Marble::GraticulePlugin::settings ( ) const

virtual

Settings of the plugin.

Settings is the map (hash table) of plugin's settings This method is called to determine the current settings of the plugin for serialization, e.g. when closing the application.

Returns

plugin's settings

See also

setSettings

Reimplemented from Marble::RenderPlugin.

Definition at line 161 of file GraticulePlugin.cpp.

void Marble::GraticulePlugin::tropicsGetColor ( )

slot

Definition at line 227 of file GraticulePlugin.cpp.

QString Marble::GraticulePlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 91 of file GraticulePlugin.cpp.

void Marble::GraticulePlugin::writeSettings ( )

slot

Definition at line 249 of file GraticulePlugin.cpp.

qreal Marble::GraticulePlugin::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 from Marble::LayerInterface.

Definition at line 293 of file GraticulePlugin.cpp.

---

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

• GraticulePlugin.h
• GraticulePlugin.cpp