Marble/OnlineServices

Creating your first Marble Online Services Plugin

Tutorial Series	Marble Tutorial
Previous	C++, Qt, KDE4 development environment
What's Next
Further Reading	CMake

This Tutorial is unfinished, I'll finish it in a few days.

Abstract

You will here learn to create your own online service plugins. If you don't know what is meant by online service, you will see these in the Marble menu at "View"->"Online Services". You'll need KDE 4.3 to build this tutorial. If you want to write plugins for Marble, it could be useful to do this in KDE's subversion. Please contact the Marble developers for this (IRC, E-Mail).

Structure

An online services plugin or data plugin consist of three classes at least. The class to display the information is the Data Item (the base class is AbstractDataPluginItem). It stores the information for single places on the map and displays them.

The Model (base class AbstractDataPluginModel) stores all items. Storing the items will be done by AbstractDataPluginModel itself. Your only job is to get information for new items when the displayed part of the earth changes. This can include downloading so called "Description files" from the servers of an online service and parsing them. These "Description files" contain lists of items in a specific part of the earth (specified by a LatLonAltBox).

The class based on AbstractDataPlugin is the representation class of our plugin. It provides the name and the idea of the plugin. You also have to set your model there.

Item

We will write our item first as it depends on nothing else. As you should already know the item stores the data and paints it on the screen. One item has an exact position on the globe as longitude, latitude and altitude. The item we will write shows a text at the specific position.

We will now look at the header file to see what functions we have to implement. TutorialItem.h // This is to prevent this header to be included multiple times

1. ifndef TUTORIALITEM_H
2. define TUTORIALITEM_H

1. include "AbstractDataPluginItem.h"

class QFont;

namespace Marble {

class TutorialItem : public AbstractDataPluginItem {

   Q_OBJECT
   
public:
   TutorialItem( QObject *parent );
   
   ~TutorialItem();
   
   // Returns the item type of the item.
   QString itemType() const;
   
   // Returns true if the item is paintable
   bool initialized();
   
   // Here the item gets painted
   void paint( GeoPainter *painter, ViewportParams *viewport,
               const QString& renderPos, GeoSceneLayer * layer = 0 );
   
   bool operator<( const AbstractDataPluginItem *other ) const;
   
   // The text we want to show on the map
   QString text() const;    
   void setText( const QString& text );
   
private:
   QString m_text;
   
   static QFont s_font;

};

}

1. endif // TUTORIALITEM_H

As you have probably seen, it will be very easy to implement this as we have only one function (paint()) besides some getters and setters.

Let's have a look at the implementation. TutorialItem.cpp // Self

1. include "TutorialItem.h"

// Marble

1. include "GeoPainter.h"
2. include "ViewportParams.h"

// Qt

1. include <QtGui/QFontMetrics>

using namespace Marble;

// That's the font we will use to paint. QFont TutorialItem::s_font = QFont( "Sans Serif", 8 );

TutorialItem::TutorialItem( QObject *parent )

   : AbstractDataPluginItem( parent )

{

   // The size of an item without a text is 0
   setSize( QSize( 0, 0 ) );

}

TutorialItem::~TutorialItem() { }

QString TutorialItem::itemType() const {

   // Our itemType:
   return "tutorialItem";

}

bool TutorialItem::initialized() {

   // The item is initialized if it has a text
   if ( m_text.isEmpty() ) 
       return false;
   else
       return true;

}

bool TutorialItem::operator<( const AbstractDataPluginItem *other ) const {

   // That's not a very nice priority estimation, you'll hopefully find
   // a better one for your plugin.
   return this->id() < other->id();

}

QString TutorialItem::text() const {

   return m_text;

}

void TutorialItem::setText( const QString& text ) {

   // On a text change our size may also change, so we have to set the new
   // item size. Marble needs to know how large an item is to find the correct
   // bounding rect. The given position will always be in the middle of the 
   // item for now.
   QFontMetrics metrics( s_font );
   setSize( metrics.size( 0, text ) );
   m_text = text;

}

void TutorialItem::paint( GeoPainter *painter, ViewportParams *viewport,

                          const QString& renderPos, GeoSceneLayer * layer )

{

   Q_UNUSED( renderPos )
   Q_UNUSED( layer )
   
   // Save the old painter state.
   painter->save();
   // We want to paint a black string.
   painter->setPen( QPen( QColor( Qt::black ) ) );
   // We will use our standard font.
   painter->setFont( s_font );
   // Draw the text into the given rect.
   painter->drawText( QRect( QPoint( 0, 0 ), size() ), 0, m_text );
   // Restore the old painter state.
   painter->restore();

}

// This is needed for all QObjects (see MOC)

1. include "TutorialItem.moc"

Wasn't that easy? Continue with the next section.

Model

We will continue developing the core component, the model. Let's first look at the header file: TutorialModel.h

1. ifndef TUTORIALMODEL_H
2. define TUTORIALMODEL_H

1. include "AbstractDataPluginModel.h"

namespace Marble {

class MarbleDataFacade;

// The maximum number of items we want to show on the screen. const quint32 numberOfItemsOnScreen = 20;

class TutorialModel : public AbstractDataPluginModel {

   Q_OBJECT

public:
   TutorialModel( QObject *parent = 0 );
   ~TutorialModel();

protected:
   /**
    * Generates the download url for the description file from the web service depending on
    * the @p box surrounding the view and the @p number of files to show.
    **/
   void getAdditionalItems( const GeoDataLatLonAltBox& box,
                            MarbleDataFacade *facade,
                            qint32 number = 10 );

};

}

1. endif // TUTORIALMODEL_H

You see that we have to implement the function getAdditionalItems(). getAdditionalItems() is called when the viewport has been changed significantly, so new items have to be generated. For getAdditionalItems() we will go the easy way for now. We will simply add one item with a static position. That's a very simple method to test your painting code.

TutorialModel.cpp // Self

1. include "TutorialModel.h"

// Plugin

1. include "TutorialItem.h"

// Marble

1. include "global.h"
2. include "MarbleDataFacade.h"
3. include "GeoDataCoordinates.h"

// Qt

1. include <QtCore/QString>

using namespace Marble;

TutorialModel::TutorialModel( QObject *parent )

   : AbstractDataPluginModel( "tutorial", parent ) 

{ }

TutorialModel::~TutorialModel() { }

void TutorialModel::getAdditionalItems( const GeoDataLatLonAltBox& box,

                                        MarbleDataFacade *facade,
                                        qint32 number )

{

   // This plugin only supports Tutorial items for earth
   if( facade->target() != "earth" ) {
       return;
   }
   
   // We will only create one item in our first tutorial.
   // Every item has to get an id. We have to check if the item already exists.
   if ( !itemExists( "tutorial1" ) ) {
       // If it does not exists, create it
       GeoDataCoordinates coor( 10.22 * DEG2RAD, 54.4 * DEG2RAD );
       // The parent of the new item is this object
       TutorialItem *item = new TutorialItem( this );
       item->setCoordinate( coor );
       item->setTarget( "earth" );
       item->setId( "tutorial1" );
       // The text we want to show, of course "Hello World!"
       item->setText( "Hello World!" );
       // Add the item to the list of items, so it will be displayed.
       addItemToList( item );
   }

}

1. include "TutorialModel.moc"

If you want to download files from a web server to get lists of items, you will want to use void downloadDescriptionFile( const QUrl& url ) and you have to reimplement void parseFile( const QByteArray& file ), which parses the downloaded description file and adds new items to the list.

If you want to download files per item (for example if you want to display images), you can use void downloadItemData( const QUrl& url, const QString& type, AbstractDataPluginItem *item ). This will also add the items to the list of items. The type is something you have to invent yourself. It has to be unique in your plugin. The function void addDownloadedFile( const QString& url, const QString& type ) of our item is called when the download has been finished. This is what you need to implement.

To see examples of the usage of these functions, look at wikipedia-plugin and photo-plugin.

Main Plugin Class

Now to the boring part of the tutorial: The main class.

TutorialPlugin.h

1. ifndef TUTORIALPLUGIN_H
2. define TUTORIALPLUGIN_H

1. include "AbstractDataPlugin.h"
2. include "RenderPlugin.h"
3. include "RenderPluginInterface.h"

1. include <QtGui/QIcon>

namespace Marble {

class TutorialPlugin : public AbstractDataPlugin {

   Q_OBJECT
   Q_INTERFACES( Marble::RenderPluginInterface )
   MARBLE_PLUGIN( TutorialPlugin )
   
public:
   TutorialPlugin();
    
   void initialize();
   
   QString name() const;
   
   QString guiString() const;
   
   QString description() const;
   
   QIcon icon() const;

};

}

And the implementation: TutorialPlugin.cpp // Self

1. include "TutorialPlugin.h"

1. include "TutorialModel.h"

using namespace Marble;

TutorialPlugin::TutorialPlugin() {

   setNameId( "tutorial" );
   
   // Plugin is enabled by default
   setEnabled( true );
   // Plugin is not visible by default
   setVisible( false );

}

void TutorialPlugin::initialize() {

   setModel( new TutorialModel( this ) );
   // Setting the number of items on the screen.
   setNumberOfItems( numberOfItemsOnScreen );

}

QString TutorialPlugin::name() const {

   return tr( "Tutorial Items" );

}

QString TutorialPlugin::guiString() const {

   return tr( "&Tutorial" );

}

QString TutorialPlugin::description() const {

   return tr( "Shows tutorial items on the map." );

}

QIcon TutorialPlugin::icon() const {

   return QIcon();

} // Because we want to create a plugin, we have to do the following line. Q_EXPORT_PLUGIN2(TutorialPlugin, Marble::TutorialPlugin)

1. include "TutorialPlugin.moc"

CMake

I build the plugin, as you will probably do, in a subdirectory of marble/src/plugins/render. This needs the following file: CMakeLists.txt PROJECT( TutorialPlugin )

INCLUDE_DIRECTORIES(

${CMAKE_CURRENT_SOURCE_DIR}/src/plugins/render/tutorialPlugin
${CMAKE_BINARY_DIR}/src/plugins/render/tutorialPlugin
${QT_INCLUDE_DIR}

)

set( tutorial_SRCS TutorialPlugin.cpp

                  TutorialModel.cpp
                  TutorialItem.cpp )

marble_add_plugin( Tutorial ${tutorial_SRCS} )

This will need the line add_subdirectory( tutorialPlugin ) in marble/src/plugins/render.

Now you can recompile and reinstall marble, so the plugin will be installed at the correct place. Starting Marble will result in an additional menu entry in "View"->"Online Services". If selected, you will see the string "Hello World!" displayed near Kiel, Germany.