Marble::SatellitesPlugin Class Reference

#include <SatellitesPlugin.h>

Inheritance diagram for Marble::SatellitesPlugin:

Public Member Functions
	SatellitesPlugin ()
	SatellitesPlugin (const MarbleModel *marbleModel)
virtual	~SatellitesPlugin ()
QString	aboutDataText () const
QStringList	backendTypes () const
SatellitesConfigDialog *	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
bool	render (GeoPainter *painter, ViewportParams *viewport, const QString &renderPos, GeoSceneLayer *layer)
QString	renderPolicy () const
QStringList	renderPosition () const
RenderType	renderType () const
void	setSettings (const QHash< QString, QVariant > &settings)
QHash< QString, QVariant >	settings () const
QString	version () 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 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 ()
Public Member Functions inherited from Marble::LayerInterface
virtual	~LayerInterface ()
virtual qreal	zValue () const
Public Member Functions inherited from Marble::DialogConfigurationInterface
virtual	~DialogConfigurationInterface ()

Protected Member Functions
void	activateDataSource (const QString &source)
void	addBuiltInDataSources ()
Protected Member Functions inherited from Marble::RenderPlugin
bool	eventFilter (QObject *, QEvent *)

Additional Inherited Members
Public Types inherited from Marble::RenderPlugin
enum	RenderType {   UnknownRenderType, TopLevelRenderType, PanelRenderType, OnlineRenderType,   ThemeRenderType }
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)
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)
Properties inherited from Marble::RenderPlugin
QString	description
bool	enabled
QString	name
QString	nameId
bool	userCheckable
QString	version
bool	visible

Detailed Description

This plugin displays satellites and their orbits.

Definition at line 31 of file SatellitesPlugin.h.

Constructor & Destructor Documentation

Marble::SatellitesPlugin::SatellitesPlugin

(

)

Definition at line 32 of file SatellitesPlugin.cpp.

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

explicit

Definition at line 39 of file SatellitesPlugin.cpp.

Marble::SatellitesPlugin::~SatellitesPlugin ( )

virtual

Definition at line 57 of file SatellitesPlugin.cpp.

Member Function Documentation

QString Marble::SatellitesPlugin::aboutDataText ( ) const

virtual

Returns about text (credits) for external data the plugin uses.

The default implementation returns the empty string. Please override this method to give credits for all data from 3rd-partys.

Reimplemented from Marble::PluginInterface.

Definition at line 117 of file SatellitesPlugin.cpp.

void Marble::SatellitesPlugin::activateDataSource ( const QString &  source )

protected

Definition at line 356 of file SatellitesPlugin.cpp.

void Marble::SatellitesPlugin::addBuiltInDataSources ( )

protected

Definition at line 366 of file SatellitesPlugin.cpp.

QStringList Marble::SatellitesPlugin::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 64 of file SatellitesPlugin.cpp.

SatellitesConfigDialog * Marble::SatellitesPlugin::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 300 of file SatellitesPlugin.cpp.

QString Marble::SatellitesPlugin::copyrightYears ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 104 of file SatellitesPlugin.cpp.

QString Marble::SatellitesPlugin::description ( ) const

virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 99 of file SatellitesPlugin.cpp.

QString Marble::SatellitesPlugin::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 89 of file SatellitesPlugin.cpp.

QIcon Marble::SatellitesPlugin::icon ( ) const

virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 129 of file SatellitesPlugin.cpp.

void Marble::SatellitesPlugin::initialize ( )

virtual

Implements Marble::RenderPluginInterface.

Definition at line 139 of file SatellitesPlugin.cpp.

bool Marble::SatellitesPlugin::isInitialized ( ) const

virtual

Implements Marble::RenderPluginInterface.

Definition at line 173 of file SatellitesPlugin.cpp.

QString Marble::SatellitesPlugin::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 79 of file SatellitesPlugin.cpp.

QString Marble::SatellitesPlugin::nameId ( ) const

virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 84 of file SatellitesPlugin.cpp.

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

virtual

Implements Marble::PluginInterface.

Definition at line 109 of file SatellitesPlugin.cpp.

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

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 178 of file SatellitesPlugin.cpp.

QString Marble::SatellitesPlugin::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 69 of file SatellitesPlugin.cpp.

QStringList Marble::SatellitesPlugin::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 74 of file SatellitesPlugin.cpp.

RenderPlugin::RenderType Marble::SatellitesPlugin::renderType ( ) const

virtual

Render type of the plugin.

Function for returning the type of plugin this is for. This affects where in the menu tree the action() is placed.

See also

RenderType

Returns

: The type of render plugin this is

Reimplemented from Marble::RenderPlugin.

Definition at line 134 of file SatellitesPlugin.cpp.

void Marble::SatellitesPlugin::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 202 of file SatellitesPlugin.cpp.

QHash< QString, QVariant > Marble::SatellitesPlugin::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 191 of file SatellitesPlugin.cpp.

QString Marble::SatellitesPlugin::version ( ) const

virtual

Implements Marble::PluginInterface.

Definition at line 94 of file SatellitesPlugin.cpp.

---

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

• SatellitesPlugin.h
• SatellitesPlugin.cpp