• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdeedu API Reference
  • KDE Home
  • Contact Us
 

marble

  • Marble
  • ElevationProfileMarker
Public Member Functions | List of all members
Marble::ElevationProfileMarker Class Reference

#include <ElevationProfileMarker.h>

Inheritance diagram for Marble::ElevationProfileMarker:
Inheritance graph
[legend]

Public Member Functions

 ElevationProfileMarker ()
 
 ElevationProfileMarker (const MarbleModel *marbleModel)
 
 ~ElevationProfileMarker ()
 
QStringList backendTypes () const
 
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=0)
 
QString renderPolicy () const
 
QStringList renderPosition () const
 
QString version () const
 
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 void setSettings (const QHash< QString, QVariant > &settings)
 
virtual QHash< QString, QVariant > settings () 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 ()
 

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)
 
- 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

Definition at line 27 of file ElevationProfileMarker.h.

Constructor & Destructor Documentation

Marble::ElevationProfileMarker::ElevationProfileMarker ( )

Definition at line 28 of file ElevationProfileMarker.cpp.

Marble::ElevationProfileMarker::ElevationProfileMarker ( const MarbleModel *  marbleModel)
explicit

Definition at line 33 of file ElevationProfileMarker.cpp.

Marble::ElevationProfileMarker::~ElevationProfileMarker ( )

Definition at line 50 of file ElevationProfileMarker.cpp.

Member Function Documentation

QStringList Marble::ElevationProfileMarker::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 54 of file ElevationProfileMarker.cpp.

QString Marble::ElevationProfileMarker::copyrightYears ( ) const
virtual

Implements Marble::PluginInterface.

Definition at line 99 of file ElevationProfileMarker.cpp.

QString Marble::ElevationProfileMarker::description ( ) const
virtual

Returns a user description of the plugin.

Implements Marble::PluginInterface.

Definition at line 94 of file ElevationProfileMarker.cpp.

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

QIcon Marble::ElevationProfileMarker::icon ( ) const
virtual

Returns an icon for the plugin.

Implements Marble::PluginInterface.

Definition at line 111 of file ElevationProfileMarker.cpp.

void Marble::ElevationProfileMarker::initialize ( )
virtual

Implements Marble::RenderPluginInterface.

Definition at line 116 of file ElevationProfileMarker.cpp.

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

Implements Marble::RenderPluginInterface.

Definition at line 129 of file ElevationProfileMarker.cpp.

QString Marble::ElevationProfileMarker::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 74 of file ElevationProfileMarker.cpp.

QString Marble::ElevationProfileMarker::nameId ( ) const
virtual

Returns the unique name of the plugin.

Examples: "starrysky", "openrouteservice"

Implements Marble::PluginInterface.

Definition at line 84 of file ElevationProfileMarker.cpp.

QList< PluginAuthor > Marble::ElevationProfileMarker::pluginAuthors ( ) const
virtual

Implements Marble::PluginInterface.

Definition at line 104 of file ElevationProfileMarker.cpp.

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

Renders the content provided by the layer on the viewport.

Parameters
painterpainter object allowing to paint on the map
viewportmetadata, such as current projection, screen dimension, etc.
renderPoscurrent render position
layerdeprecated, always zero (NULL)
Returns
true Returns whether the rendering has been successful

Implements Marble::LayerInterface.

Definition at line 134 of file ElevationProfileMarker.cpp.

QString Marble::ElevationProfileMarker::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 59 of file ElevationProfileMarker.cpp.

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

QString Marble::ElevationProfileMarker::version ( ) const
virtual

Implements Marble::PluginInterface.

Definition at line 89 of file ElevationProfileMarker.cpp.

qreal Marble::ElevationProfileMarker::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 69 of file ElevationProfileMarker.cpp.


The documentation for this class was generated from the following files:
  • ElevationProfileMarker.h
  • ElevationProfileMarker.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:38:55 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

marble

Skip menu "marble"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdeedu API Reference

Skip menu "kdeedu API Reference"
  • Analitza
  •     lib
  • kalgebra
  • kalzium
  •   libscience
  • kanagram
  • kig
  •   lib
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  • marble
  • parley
  • rocs
  •   App
  •   RocsCore
  •   VisualEditor
  •   stepcore

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal