Marble: Difference between revisions

From KDE TechBase
No edit summary
No edit summary
(87 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Projects/Marble}}


__NOTOC__
 
[[Image:Marble_logo.png]]
[[Image:Marble_logo.png]]


== About Marble ==
== About Marble ==
;[[/Devices_and_Use_Cases|Devices and Use Cases]]
;[[/FAQ|Marble FAQ]]
;[[/FAQ|Marble FAQ]]


== Examples of Use ==
== Success Stories: 3rd party applications using the Marble Library==
;[[/MarbleUsedBy|Applications using the Marble library]]
;[[/MarbleUsedBy|Software that makes use of Marble]]
 
== Tutorials: How to use the Marble Widget in your application ==
;[[/MarbleDesigner|with Qt Designer]]
;[[/MarbleWindows|On Windows, with Qt Creator/Qt Designer]]
 
=== With C++ ===
==== Intro ====
;[[/MarbleCPlusPlus|Hello World]]
;[[/MarbleMarbleWidget|Changing basic map properties]]
;[[/MarbleSignalsSlots|Creating a window with controls]]
 
==== GeoData ====
;[[/Runners/DisplayGeoDataPlacemark|Displaying GeoData Documents]]
 
==== Online Services ====
;[[/OnlineServices|Creating new Online Services]]
 
==== Routing ====
;[[/Routing/BasicRouting|Basic Routing]]
 
==== Runners ====
;[[/Runners/Search|Searching for Points of Interest]]
;[[/Runners/ReverseGeocoding|Reverse Geocoding]]
;[[/Runners/Parse|Parsing Files]]
 
==== GeoPainter ====
;[[/MarbleGeoPainter|Painting onto the map]]
;[[/LayerInterface|Drawing in Custom Layers]]
;[[/Runners/PaintingGeoDataLineString|Painting LineString]]
 
=== With Python ===
==== Intro ====
;[http://techbase.kde.org/Projects/Marble/MarblePythonInstructions Installing Marble's Python bindings]
;[[/MarblePythonHello|Hello World]]
;[[/MarblePythonMarbleWidget|Changing basic map properties]]
;[[/MarblePythonSignalsSlots|Creating a window with controls]]
 
==== Loading Files ====
;[[/Runners/MarblePythonLoadingKML|Loading KML files into Marble]]
;[[/Runners/MarblePythonLoadingOSM|Loading OSM files into Marble]]
 
==== GeoData ====
;[[/Runners/MarblePythonDisplayGeoDataPlacemark|Display GeoData Placemark]]
;[[/Runners/MarblePythonVehicleTracking|Vehicle Tracking]]
 
==== Routing/Runners ====
This part of the Python API has not yet been ported and the tutorials could not be completed. [https://bugs.kde.org/show_bug.cgi?id=329364 see this bug for more info].
 
==== GeoPainter ====
;[[/Routing/MarblePythonGeoPainter|Painting onto the map]]
;[[/MarblePythonLayerInterface|Drawing in Custom Layers]]


== Using the Marble Widget in other applications ==
;[[/MarbleDesigner|with QtDesigner]]
;[[/MarbleCPlusPlus|with C++]]
;[[/MarblePython|with Python]]


;[[/MarbleDBus|via a shell script]]
;[[/MarbleDBus|via a shell script]]
Line 26: Line 73:


;[[/GoMarble|How to become a Marble Developer]]
;[[/GoMarble|How to become a Marble Developer]]
== Compiling Marble ==
;[[/LinuxCompiling|Compiling on Linux]]
;[[/WindowsCompiling|Compiling on Windows]]
;[[/MaemoEnvironment|Compiling on Maemo]]
;[[/MeeGoEnvironment|Compiling on MeeGo]]
;[[/PlasmaActiveEnvironment|Compiling for Plasma Active]]
;[[/MacCompiling|Compiling on Mac OS]]
;[[/AndroidCompiling|Compiling for Android]]
;[[/QtCreator|Setting up QtCreator for Marble Development]]


== Packaging Marble ==
== Packaging Marble ==


Here is some advice about how packaging is supposed to happen on the various plattforms that are supported.
;[[/NewMarbleMoldules|New Marble Modules]] (future packaging advice)


Here is some advice about how packaging is supposed to happen on the various platforms that are supported.
;[[/LinuxPackaging|Packaging for Linux]]
;[[/WindowsPackaging|Packaging for Windows]]
;[[/MaemoPackaging|Packaging for Maemo]]
;[[/MeeGoPackaging|Packaging for MeeGo]]
;[[/MacPackaging|Packaging for Mac]]
;[[/MacPackaging|Packaging for Mac]]


Line 36: Line 99:


Here are some tools and checks that are performed on marble code:
Here are some tools and checks that are performed on marble code:
;[https://bugs.kde.org/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&product=marble&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&cmdtype=doit&order=Importance Marble Open Bugs]
;[http://reviewboard.kde.org/groups/marble/ Review Board]
;[http://reviewboard.kde.org/groups/marble/ Review Board]
;[http://api.kde.org/4.2-api/kdeedu-apidocs/marble/src/html/index.html API Docs (KDE4.2)]
;[http://api.kde.org/4.x-api/kdeedu-apidocs/marble/html/index.html API Docs (KDE Trunk)]
;[http://www.englishbreakfastnetwork.org/apidocs/apidox-kde-4.x/kdeedu-marble.html APIDOX reports]
;[http://www.englishbreakfastnetwork.org/apidocs/apidox-kde-4.x/kdeedu-marble.html APIDOX reports]
;[http://www.englishbreakfastnetwork.org/krazy/reports/kde-4.x/kdeedu/marble/index.html Krazy reports]
;[http://www.englishbreakfastnetwork.org/krazy/reports/kde-4.x/kdeedu/marble/index.html Krazy reports]
Line 44: Line 108:


Here are a few links to various issues we are working on:
Here are a few links to various issues we are working on:
;[[Marble 2.0]]
;[[/TODO|TODO list]]
;[[/MaemoTODO|Maemo specific TODO list]]
=== Google Summer of Code / ESA SoCIS ===
;[[/Gsoc2010| Gsoc Students projects 2010]]
;[[/GsocGit| Use of git(orious) for GSOC]]
;[[/GSoC2011| GSoC Students' projects 2011]]
;[http://community.kde.org/SoCiS/2011/Ideas#Marble_Virtual_Globe ESA SoCIS 2011 ideas]
;[[/GSoC2012| GSoC Students' projects 2012]]
=== Translation ===
;[[/MapTranslation|Map Translation]]
;[[/UiTranslation|UI Translation]]
;[[/GeoDataCoordinatesTranslation|GeoDataCoordinates Translation]]


=== User Interface ===
=== User Interface ===
;[[/Mockups|Mockups]]
;[[/Mockups|Mockups]]
;[[/IconStatus|Icon Status]]


=== Texture Mapping ===
=== Texture Mapping ===
Line 52: Line 132:


=== GeoData Library / KML ===
=== GeoData Library / KML ===
;[[/GeoData|GeoData]]
The base classes to manipulate geographic data
;[[/GeoData|GeoData Presentation]]
;[[/GeoData/GeoDataUse|Use cases for GeoData classes]]
;[http://websvn.kde.org/*checkout*/trunk/KDE/kdeedu/marble/src/lib/geodata/data/README.html GeoData API Description]
;[[/GeoData/GeoDataParsing|Parsing GeoData]]
;[[/GeoData/GeoDataWriter|Writing GeoData]]
;[[/GeoData/PointerVsImplicitShare|Pointer vs. Implicit Share]]
 
 
;[[/KMLStatus|KML Status]]
;[[/KMLStatus|KML Status]]
;[[/GPXStatus|GPX Status]]
;[[/GPXStatus|GPX Status]]
Using GeoData:
;[[/Placemark|Placemarks Management]]
;[[/ModelView|Review of Model-View use in marble]]


=== Geo Graphics View ===  
=== Geo Graphics View ===  
;[[/GeoGraphicsViewOverview|Overview of the plans for GeoGraphicsView]]
;[[/GeoGraphicsViewOverview|Overview of the GeoGraphicsView]]
;[[/GraphicsViewGeoParser| Developing the GeoParser to work with GeoGraphicsView]]
;[[/GraphicsViewGeoParser| Interaction between GeoData and GeoGraphicsView]]


=== GeoPainter / DGML ===
=== GeoPainter / DGML ===
;[[/GeoPainter|GeoPainter]]
;[[/GeoPainter|GeoPainter]]
;[[/Dgml|DGML]]
;[[/Dgml|DGML]]
=== Plugin Interfaces ===
;[[/Plugins|Plugin interfaces]]


=== Marble Runner ===
=== Marble Runner ===
Line 68: Line 163:
;[[/OsmNameFinderRunner|OSM Runner]]
;[[/OsmNameFinderRunner|OSM Runner]]
;[[/RunnerHOWTO|Runner HOWTO]]
;[[/RunnerHOWTO|Runner HOWTO]]
=== Online Services ===
;[[/ListOfPossibleOnlineServices|List of possible Online Services]]


=== Projections ===
=== Projections ===
;[[/WinkelIii|Winkel III]]
;[[/WinkelIii|Winkel III]]
;[[/RobinsonProjection|Robinson projection]]
[http://www.radicalcartography.net/?projectionref A little overview of map projections]


=== Tile Download ===
=== Tile Download ===
;[[/VectorTilingProposal|Vector Tiling Proposal]]
;[[/TileDownload|Tile Download]]
;[[/TileDownload|Tile Download]]


=== Documentation ===
=== Documentation ===
;[[/CustomPlanetMaps|How to create maps for other planets, moons etc.]]
;[[/CustomMaps|How to customize maps]]
;[[/CustomMaps|How to customize maps]]
;[[/PNTFiles|How to change the PNT files used by Marble]]
;[[/MarblesSecrets|Marble's Secrets]]
;[[/MarblesSecrets|Marble's Secrets]]
;[[/ProxyConnection|How to use the Proxy]]
;[[/ProxyConnection|How to use the Proxy]]
Line 82: Line 186:
=== GeoClue / GPS ===
=== GeoClue / GPS ===
;[[/GeoClue|GeoClue support in Marble]]
;[[/GeoClue|GeoClue support in Marble]]
=== XDG Base Directory Specification ===
;[[/xdg|XDG Base Directory Specification]]


== Mapping Coordination ==
== Mapping Coordination ==
Possible maps we could use:
* [http://pelagios.dme.ait.ac.at/maps/greco-roman/ Tiled map of the classical world] see the [http://pelagios-project.blogspot.co.uk/2012/09/a-digital-map-of-roman-empire.html authors blog] for details
* [http://www.unearthedoutdoors.net/global_data/true_marble/download TrueMarble Global 250m images]
* [http://onearth.jpl.nasa.gov/ OnEarth NASA satellite images]
* [http://worldwindcentral.com/wiki/Add-on:ZoomIt! ZoomIt! (in parts proprietary)]
* [http://sos.noaa.gov/datasets/ NOAA Science on a Sphere]
* [http://efele.net/maps/tz/world/ Olsen Time Zone map in Shapefile format].  Public Domain.  Scripted to generate from current tz file.
=== OSM Vector Map ===
;[[/OSMVectorCompile|How to compile Marble with vector support]]
;[[/OSMVectorTileCreation|How to build tiles]]
;[[/OSMVectorGoals|Goals of the Vector OSM map]]
=== Natural Earth Vector Map ===
;[[/NaturalEarth|A proposal to use the Natural Earth vector map]]
=== Documentation ===
=== Documentation ===
;[[/HistoricalMaps|How to create Historical Maps]]
;[[/HistoricalMaps|How to create Historical Maps]]
;[[/CustomMaps|How to create Custom Maps]]


;[[/PalaeoMaps|Global Palaeogeography]]
;[[/PalaeoMaps|Global Palaeogeography]]


== Routing ==
== Routing ==
;[[/RoutingIdeas|General ideas about routing]]
;[[/OnlineRoutingImplementation|Implementation of Online-Routing]]
;[[/MaemoOfflineRouting|Installation of Marble and Gosmore on Maemo]]
;[[/RoutingRoadmap|Routing Roadmap]]
;[[/RoutingInstructions|Routing Instructions]]


== valgrind  ==
== valgrind  ==
Line 100: Line 228:
Summaries and logs of scheduled Marble meetings can be found on the following pages:
Summaries and logs of scheduled Marble meetings can be found on the following pages:
;[[/MarbleMeeting20081029|Wednesday Nov. 10th, 2008]]
;[[/MarbleMeeting20081029|Wednesday Nov. 10th, 2008]]
;[[/MarbleMeeting20101107|Marble Weekend Sprint, Nov. 5-7]]

Revision as of 12:19, 26 December 2015


About Marble

Devices and Use Cases
Marble FAQ

Success Stories: 3rd party applications using the Marble Library

Software that makes use of Marble

Tutorials: How to use the Marble Widget in your application

with Qt Designer
On Windows, with Qt Creator/Qt Designer

With C++

Intro

Hello World
Changing basic map properties
Creating a window with controls

GeoData

Displaying GeoData Documents

Online Services

Creating new Online Services

Routing

Basic Routing

Runners

Searching for Points of Interest
Reverse Geocoding
Parsing Files

GeoPainter

Painting onto the map
Drawing in Custom Layers
Painting LineString

With Python

Intro

Installing Marble's Python bindings
Hello World
Changing basic map properties
Creating a window with controls

Loading Files

Loading KML files into Marble
Loading OSM files into Marble

GeoData

Display GeoData Placemark
Vehicle Tracking

Routing/Runners

This part of the Python API has not yet been ported and the tutorials could not be completed. see this bug for more info.

GeoPainter

Painting onto the map
Drawing in Custom Layers


via a shell script

How to become a Marble developer ("Marblehead")

So you are new to Marble development ...

Welcome!

Here you'll get all the information you need to start Marble development:

How to become a Marble Developer

Compiling Marble

Compiling on Linux
Compiling on Windows
Compiling on Maemo
Compiling on MeeGo
Compiling for Plasma Active
Compiling on Mac OS
Compiling for Android
Setting up QtCreator for Marble Development

Packaging Marble

New Marble Modules (future packaging advice)

Here is some advice about how packaging is supposed to happen on the various platforms that are supported.

Packaging for Linux
Packaging for Windows
Packaging for Maemo
Packaging for MeeGo
Packaging for Mac

Tools for Marble

Here are some tools and checks that are performed on marble code:

Marble Open Bugs
Review Board
API Docs (KDE Trunk)
APIDOX reports
Krazy reports

Programming Coordination

Here are a few links to various issues we are working on:

Marble 2.0
TODO list
Maemo specific TODO list

Google Summer of Code / ESA SoCIS

Gsoc Students projects 2010
Use of git(orious) for GSOC
GSoC Students' projects 2011
ESA SoCIS 2011 ideas
GSoC Students' projects 2012

Translation

Map Translation
UI Translation
GeoDataCoordinates Translation

User Interface

Mockups
Icon Status

Texture Mapping

Texture Mapping

GeoData Library / KML

The base classes to manipulate geographic data

GeoData Presentation
Use cases for GeoData classes
GeoData API Description
Parsing GeoData
Writing GeoData
Pointer vs. Implicit Share


KML Status
GPX Status

Using GeoData:

Placemarks Management
Review of Model-View use in marble

Geo Graphics View

Overview of the GeoGraphicsView
Interaction between GeoData and GeoGraphicsView

GeoPainter / DGML

GeoPainter
DGML

Plugin Interfaces

Plugin interfaces

Marble Runner

Coordinate Runner
OSM Runner
Runner HOWTO

Online Services

List of possible Online Services

Projections

Winkel III
Robinson projection

A little overview of map projections

Tile Download

Vector Tiling Proposal
Tile Download

Documentation

How to create maps for other planets, moons etc.
How to customize maps
How to change the PNT files used by Marble
Marble's Secrets
How to use the Proxy

GeoClue / GPS

GeoClue support in Marble

XDG Base Directory Specification

XDG Base Directory Specification

Mapping Coordination

Possible maps we could use:

OSM Vector Map

How to compile Marble with vector support
How to build tiles
Goals of the Vector OSM map

Natural Earth Vector Map

A proposal to use the Natural Earth vector map


Documentation

How to create Historical Maps
How to create Custom Maps
Global Palaeogeography

Routing

Implementation of Online-Routing
Installation of Marble and Gosmore on Maemo
Routing Roadmap
Routing Instructions

valgrind

if you want to fix memory leaks, you can run valgrind with:

valgrind --leak-check=full --track-origins=yes --num-callers=30 marble 2>&1 | tee MARBLE_MEMCHECK

Meetings

Summaries and logs of scheduled Marble meetings can be found on the following pages:

Wednesday Nov. 10th, 2008
Marble Weekend Sprint, Nov. 5-7