forked from KDE/marble
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Mainpage.dox
56 lines (44 loc) · 2.56 KB
/
Mainpage.dox
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
/** @mainpage Marble
Marble is an application that displays a view of the earth. It is
both a valuable application in its own right, but also an example
program that shows how you can use the Marble widgets in your own
applications.
We have designed Marble so that you can use its components easily to
enhance your application with geo services. This manual enumerates the
components and describes how to use them in your own application.
The Marble application makes use of the following classes and widgets:
1. MarbleWidget, the main widget in any application using the Marble
framework. This widget displays a view of the earth or any other
globe, depending on which dataset is used. The user can navigate
the globe using either a control widget, e.g. the MarbleControlBox,
or the mouse.
2. MarbleModel, the data storage class that holds the data that is
visualized in the MarbleWidget. The MarbleModel is created internally
and can be accessed using the model() method.
This data model contains several separate datatypes, among them:
<b>tiles</b> which provide the background map, <b>vectors</b> which
provide things like country borders and coastlines and <b>placemarks</b>
which can show points of interest, such as cities, mountain tops or the poles.
3. MarbleControlBox, the most advanced control widget for
MarbleWidget. It can be used to navigate around the globe, zoom,
search for placemarks like cities, control aspects of the view such
as showing water bodies, ice, terrain types, and cities. It can
also be used to control which dataset is used to provide the
background for the image and the projection.
These three classes provide the core of the classes that comprise the
Marble framework. You can use only them and get a very capable
application.
In addition to this, there is also a simpler control widget called the
MarbleNavigator that only controls panning and zooming. The
MarbleNavigator is incorporated into the MarbleControlBox in the first
tab. This control widget can be used in simpler application where
theming, searching and other advanced controls are not needed.
To help you get started, we provide small example programs which you can
find in the examples/cpp directory of the sources. They are also available
online at <a href="http://techbase.kde.org/Projects/Marble/MarbleCPlusPlus">KDE TechBase</a>.
@see Marble::MarbleWidget
@see Marble::MarbleModel
@see Marble::MarbleControlBox
@see Marble::MarbleNavigator
@see <a href="http://techbase.kde.org/Projects/Marble/MarbleCPlusPlus">KDE TechBase: MarbleCPlusPlus</a>
*/