Marble::RenderPluginInterface

Search for usage in LXR

Marble::RenderPluginInterface Class Referenceabstract

#include <RenderPluginInterface.h>

Inheritance diagram for Marble::RenderPluginInterface:

Public Member Functions

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 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 QVector< PluginAuthor > pluginAuthors () const =0
 
virtual QString version () const =0
 

Detailed Description

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

Definition at line 25 of file RenderPluginInterface.h.

Constructor & Destructor Documentation

◆ ~RenderPluginInterface()

Marble::RenderPluginInterface::~RenderPluginInterface ( )
override

Definition at line 11 of file RenderPluginInterface.cpp.

Member Function Documentation

◆ backendTypes()

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::AbstractDataPlugin.

◆ renderPolicy()

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::AbstractDataPlugin, and Marble::AbstractFloatItem.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 26 2024 11:57:58 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.