Projects/Marble/ModelView - Revision history

Tgridel at 10:43, 30 January 2011

2011-01-30T10:43:56Z

Tgridel at 23:55, 14 August 2010

2010-08-14T23:55:46Z

Tgridel at 22:52, 29 June 2010

2010-06-29T22:52:57Z

Tgridel at 17:55, 14 September 2009

2009-09-14T17:55:57Z

Tgridel at 16:14, 13 September 2009

2009-09-13T16:14:52Z

Tgridel at 22:02, 31 July 2009

2009-07-31T22:02:06Z

Tgridel at 20:48, 28 July 2009

2009-07-28T20:48:42Z

Mansona: Filling in the status on the GpxFileModel

2009-07-28T09:20:55Z

Filling in the status on the GpxFileModel

Tgridel: Created page with '== ModelView framework in Marble == Marble uses Qt's Model/View framework as a way to signal updates to a model to interested parts. In that respect, a Model class can wrap any ...'

2009-07-25T18:42:30Z

Created page with '== ModelView framework in Marble == Marble uses Qt's Model/View framework as a way to signal updates to a model to interested parts. In that respect, a Model class can wrap any ...'

New page

== ModelView framework in Marble ==

Marble uses Qt's Model/View framework as a way to signal updates to a model to interested parts. In that respect, a Model class can wrap any possible data.

Here is the list of Model class, and a description of how they are used.

=== QAbstractItemModel ===
* {{class|GeoDataDebugModel|kdeedu}}
It represents a data file, parsed into a {{class|GeoDataDocument|kdeedu}} tree structure.

It is used by the {{class|DataViewPlugin|kdeedu}} debug plugin (and is broken atm)

* {{class|GpxFileModel|kdeedu}}
It represents a list of gpx data file represented as {{class|GpxFile|kdeedu}}

It is used by the {{class|GpxLayer|kdeedu}} to load files and access them (and it doesn't look like it needs the Model-specific methods)

* {{class|MarbleGeometryModel|kdeedu}}
It represents the {{class|GeoDataGeometry|kdeedu}} and the {{class|GeoDataFeature|kdeedu}} items of the {{class|GeoDataDocument|kdeedu}} which contains all Placemarks.

It is used by the {{class|GeoRenderPlugin|kdeedu}} to access the list of placemarks.

=== QAbstractListModel ===
* {{class|FileViewModel|kdeedu}}
It represents the list of files opened. The {{class|PlacemarkManager|kdeedu}} appends the documents it opens, and the {{class|MarbleWidget|kdeedu}} appends the gpx files it opens.

It is used by the {{class|FileViewFloatItem|kdeedu}} and manipulated by the {{class|PlaceMarkManager|kdeedu}} and the {{class|MarbleModel|kdeedu}}.

* {{class|MarbleGeoDataModel|kdeedu}}
It represents a list of {{class|GeoDataDocuments|kdeedu}}. Only the {{class|PlacemarksPlugin|kdeedu}} uses it

It is used by no other code.

* {{class|MarblePlacemarkModel|kdeedu}}
It represents

It is used by

@@ Line 3: / Line 3: @@
 Marble uses Qt's Model/View framework as a way to signal updates to a model to interested parts. In that respect, a Model class can wrap any possible data.
-The multiple models in Marble each fit the purpose of feeding some GeoData classes to interested widgets. The way those models are fed could be improved however:
+The Model-View framework is designed to hide the details of the model content, and to present it in a standardised way to views. The advantage of this solution is that the View need not know much about the data it presents.
-== Model and Data Location ==
+The multiple models and proxies in Marble each fit the purpose of feeding some GeoData classes to interested widgets. Those models are fed by the {{class|FileManager|kdeedu|4.x}}.
-* At the moment, each Model contains the list/vector/tree of data it presents. This is not a problem per se, unless all those models present the same data, and retain their own copies. We should ensure that we do not make copies of data throughout models, but use pointers to the same data instead.
+Here is the list of Model and Proxy classes, and a description of how they are used.
-The solution to this is twofold:
+=== GeoDataTreeModel ===
-** keep data unique in one store (wherever that is, a Model class or a list in one Manager)
+The {{class|GeoDataTreeModel|kdeedu|4.x}} represents the list of all {{class|GeoDataDocument|kdeedu|4.x}} registered through the {{class|FileManager|kdeedu|4.x}}.
-** Try and manipulate references to the data in the Models in such a case: with one change to the central data, multiple models can be notified and each react differently for the views they feed.
-−
-== Model or not Model ==
-−
-* The Model-View framework is designed to hide the details of the model content, and to present it in a standardised way to views. The advantage of this solution is that the View need not know much about the data it presents.
-−
-This solution however is not a one size fit all, because an interested class with some knowledge of the GeoDataTypes for example would be far better off manipulating the methods of GeoData classes.
-−
-As a consequence, a choice should be made whether to access GeoData through the model-view framework (nice for a List Widget or for a generic presentation of 'data as a tree', really not so nice for a class which for example would like to calculate the bounding box of all geometric data of a GeoDataDocument, or even for the File read/write, as the knowledge of data types is really known).
-−
-== State of the Model ==
-−
-There are multiple models with various levels of implementation. Some are needed, others should die...
-−
-Here is the list of Model class, and a description of how they are used.
-−
-=== QAbstractItemModel ===
-* {{class|GeoDataTreeModel|kdeedu|4.x}}
-It represents the list of all {{class|GeoDataDocument|kdeedu|4.x}} registered through the {{class|FileManager|kdeedu|4.x}}.
 It has signals/slots to react to files being added or removed in the FileManager.
-It is used by the {{class|GeometryLayer|kdeedu|4.x}} which renders all {{class|GeoDataGeometry|kdeedu|4.x}} related placemarks.
+It is used as the base model for GeoDataDocuments.
-−
-* {{class|GeoDataDebugModel|kdeedu|4.x}}
-It represents a data file, parsed into a {{class|GeoDataDocument|kdeedu|4.x}} tree structure.
-−
-It is used by the {{class|DataViewPlugin|kdeedu|4.x}} debug plugin (and is broken atm)
-−
-=== QAbstractListModel ===
-* {{class|FileViewModel|kdeedu|4.x}}
-It represents the list of opened files. The {{class|FileManager|kdeedu|4.x}} appends the documents it opens.
-It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and manipulated by the {{class|FileManager|kdeedu|4.x}}.
+The {{class|GeometryLayer|kdeedu|4.x}} renders all {{class|GeoDataGeometry|kdeedu|4.x}} related placemarks.
-* {{class|MarblePlacemarkModel|kdeedu|4.x}}
+=== FileViewModel ===
-It represents the list of all Placemarks of all opened files. the {{class|PlaceMarkManager|kdeedu|4.x}} appends all the placemarks after reading a file.
+The {{class|FileViewModel|kdeedu|4.x}} represents the list of opened files. The {{class|FileManager|kdeedu|4.x}} appends the documents it opens.
-It is used by the {{class|MarbleControlBox|kdeedu|4.X}} to provide the list of placemarks to search for, and by the {{class|PlacemarkLayout|kdeedu|4.x}} to determine layouting on the map.
+=== KDescendantsProxyModel ===
-It should be replaced by a more generic model, which would hold all open documents and provide both features and geometries. It could also be replaced with a ProxyModel around this new model.
+The {{class|MarbleControlBox|kdeedu|4.X}} uses that proxy model to provide the list of placemarks to search for, and the {{class|PlacemarkLayout|kdeedu|4.x}} uses it also to determine layouting on the map.

@@ Line 7: / Line 7: @@
 == Model and Data Location ==
-* At the moment, each Model contains the list/vector/tree of data it presents. This is not a problem per se, unless all those models present the same data, and retain their own copies. Once the time to edit this data comes, it is tedious or quite impossible to trace back all those copies.
+* At the moment, each Model contains the list/vector/tree of data it presents. This is not a problem per se, unless all those models present the same data, and retain their own copies. We should ensure that we do not make copies of data throughout models, but use pointers to the same data instead.
 The solution to this is twofold:
@@ Line 28: / Line 28: @@
 === QAbstractItemModel ===
 * {{class|GeoDataDebugModel|kdeedu|4.x}}
 It represents a data file, parsed into a {{class|GeoDataDocument|kdeedu|4.x}} tree structure.
 It is used by the {{class|DataViewPlugin|kdeedu|4.x}} debug plugin (and is broken atm)
 === QAbstractListModel ===
@@ Line 52: / Line 45: @@
 It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and manipulated by the {{class|FileManager|kdeedu|4.x}}.
 * {{class|MarblePlacemarkModel|kdeedu|4.x}}

@@ Line 44: / Line 44: @@
 It is used by the {{class|GeoRenderPlugin|kdeedu|4.x}} to access the list of vector data to draw it.
 === QAbstractListModel ===
 * {{class|FileViewModel|kdeedu|4.x}}
-It represents the list of opened files. The {{class|PlacemarkManager|kdeedu|4.x}} appends the documents it opens, and the {{class|MarbleWidget|kdeedu}} appends the gpx files it opens.
+It represents the list of opened files. The {{class|FileManager|kdeedu|4.x}} appends the documents it opens.
-It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and manipulated by the {{class|PlaceMarkManager|kdeedu|4.x}} and the {{class|MarbleModel|kdeedu|4.x}}.
+It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and manipulated by the {{class|FileManager|kdeedu|4.x}}.
 * {{class|MarbleGeoDataModel|kdeedu|4.x}}
 It represents a list of {{class|GeoDataDocuments|kdeedu|4.x}}. Only the {{class|PlacemarksPlugin|kdeedu|4.x}} uses it
-It is used by no other code.
+It is used by no other code. It should be removed.
 * {{class|MarblePlacemarkModel|kdeedu|4.x}}
-It represents the list of all Placemarks of all opened kml files. the {{class|PlaceMarkManager|kdeedu|4.x}} appends all the placemarks after reading a file.
+It represents the list of all Placemarks of all opened files. the {{class|PlaceMarkManager|kdeedu|4.x}} appends all the placemarks after reading a file.
 It is used by the {{class|MarbleControlBox|kdeedu|4.X}} to provide the list of placemarks to search for, and by the {{class|PlacemarkLayout|kdeedu|4.x}} to determine layouting on the map.

@@ Line 1: / Line 1: @@
-== ModelView framework in Marble ==
+= ModelView framework in Marble =
-Marble uses Qt's Model/View framework as a way to signal updates in a model to interested parts. In that respect, a Model class can wrap any possible data.
+Marble uses Qt's Model/View framework as a way to signal updates to a model to interested parts. In that respect, a Model class can wrap any possible data.
-Here is the list of Model classes, and a description of how they are used.
+The multiple models in Marble each fit the purpose of feeding some GeoData classes to interested widgets. The way those models are fed could be improved however:
 === QAbstractItemModel ===
 * {{class|GeoDataDebugModel|kdeedu|4.x}}
-It represents the tree of {{class|GeoDataObject|kdeedu|4.x}} elements corresponding to a {{class|GeoDataDocument|kdeedu|4.x}}.
+It represents a data file, parsed into a {{class|GeoDataDocument|kdeedu|4.x}} tree structure.
-It is used by the {{class|DataViewPlugin|kdeedu|4.x}} debug plugin (and is broken atm).
+It is used by the {{class|DataViewPlugin|kdeedu|4.x}} debug plugin (and is broken atm)
 * {{class|GpxFileModel|kdeedu|4.x}}
-It represents a list of gpx data files represented as {{class|GpxFile|kdeedu|4.x}}
+It represents a list of gpx data file represented as {{class|GpxFile|kdeedu|4.x}}
 This was originally intended to but used as the model for the File List View ( which is accessible by running marble with --enableFileView ) but has since been replaced by the FileViewModel.
-The model is used as a member in the GpsLayer to hold the list of gpx files as a collection class and is deprecated. This, along with the whole current GPX implementation, needs to be removed and updated to the current concepts in Marble. See [[Projects/Marble/GPXStatus|Gpx Status]]
+The model that is in the GpsLayer is currently only being used as a collection class and is deprecated. This, along with the whole current GPX implementation, needs to be removed and updated to the current concepts in Marble. See [[Projects/Marble/GPXStatus|Gpx Status]]
 * {{class|MarbleGeometryModel|kdeedu|4.x}}
 It represents the {{class|GeoDataGeometry|kdeedu}} and the {{class|GeoDataFeature|kdeedu|4.x}} items of the last opened {{class|GeoDataDocument|kdeedu|4.x}}.
-It is used by the {{class|GeoRenderPlugin|kdeedu|4.x}} to access the list of vector data and draw it.
+It is used by the {{class|GeoRenderPlugin|kdeedu|4.x}} to access the list of vector data to draw it.
 === QAbstractListModel ===
 * {{class|FileViewModel|kdeedu|4.x}}
-It represents the list of opened files. The {{class|FileManager|kdeedu|4.x}} signals it about the documents it opens or closes.
+It represents the list of opened files. The {{class|PlacemarkManager|kdeedu|4.x}} appends the documents it opens, and the {{class|MarbleWidget|kdeedu}} appends the gpx files it opens.
-It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and by a List widget in the {{class|MarbleControlBox|kdeedu|4.X}}.
+It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and manipulated by the {{class|PlaceMarkManager|kdeedu|4.x}} and the {{class|MarbleModel|kdeedu|4.x}}.
 * {{class|MarbleGeoDataModel|kdeedu|4.x}}
-It represents a list of {{class|GeoDataDocuments|kdeedu|4.x}}. Only the {{class|PlacemarksPlugin|kdeedu|4.x}} uses it.
+It represents a list of {{class|GeoDataDocuments|kdeedu|4.x}}. Only the {{class|PlacemarksPlugin|kdeedu|4.x}} uses it
 It is used by no other code.
 * {{class|MarblePlacemarkModel|kdeedu|4.x}}
-It represents a list of Placemarks.
+It represents the list of all Placemarks of all opened kml files. the {{class|PlaceMarkManager|kdeedu|4.x}} appends all the placemarks after reading a file.
-−
-The {{class|PlaceMarkManager|kdeedu|4.x}} appends all the placemarks contained in the {{class|GeoDataDocument|kdeedu|4.x}} it knows about in its instance.
-−
-The {{class|MarbleRunnerManager|kdeedu|4.x}} appends the list of placemarks that the Runners found in its instance.
-−
-It is used by the {{class|MarbleControlBox|kdeedu|4.X}} to provide a list of placemarks (either from the PlacemarkManager or from the MarbleRunnerManager).
-It is also used by the {{class|PlacemarkLayout|kdeedu|4.x}} to determine layouting on the map.
+It is used by the {{class|MarbleControlBox|kdeedu|4.X}} to provide the list of placemarks to search for, and by the {{class|PlacemarkLayout|kdeedu|4.x}} to determine layouting on the map.

@@ Line 1: / Line 1: @@
 == ModelView framework in Marble ==
-Marble uses Qt's Model/View framework as a way to signal updates to a model to interested parts. In that respect, a Model class can wrap any possible data.
+Marble uses Qt's Model/View framework as a way to signal updates in a model to interested parts. In that respect, a Model class can wrap any possible data.
-Here is the list of Model class, and a description of how they are used.
+Here is the list of Model classes, and a description of how they are used.
 === QAbstractItemModel ===
 * {{class|GeoDataDebugModel|kdeedu|4.x}}
-It represents a data file, parsed into a {{class|GeoDataDocument|kdeedu|4.x}} tree structure.
+It represents the tree of {{class|GeoDataObject|kdeedu|4.x}} elements corresponding to a {{class|GeoDataDocument|kdeedu|4.x}}.
-It is used by the {{class|DataViewPlugin|kdeedu|4.x}} debug plugin (and is broken atm)
+It is used by the {{class|DataViewPlugin|kdeedu|4.x}} debug plugin (and is broken atm).
 * {{class|GpxFileModel|kdeedu|4.x}}
-It represents a list of gpx data file represented as {{class|GpxFile|kdeedu|4.x}}
+It represents a list of gpx data files represented as {{class|GpxFile|kdeedu|4.x}}
 This was originally intended to but used as the model for the File List View ( which is accessible by running marble with --enableFileView ) but has since been replaced by the FileViewModel.
-The model that is in the GpsLayer is currently only being used as a collection class and is deprecated. This, along with the whole current GPX implementation, needs to be removed and updated to the current concepts in Marble. See [[Projects/Marble/GPXStatus|Gpx Status]]
+The model is used as a member in the GpsLayer to hold the list of gpx files as a collection class and is deprecated. This, along with the whole current GPX implementation, needs to be removed and updated to the current concepts in Marble. See [[Projects/Marble/GPXStatus|Gpx Status]]
 * {{class|MarbleGeometryModel|kdeedu|4.x}}
 It represents the {{class|GeoDataGeometry|kdeedu}} and the {{class|GeoDataFeature|kdeedu|4.x}} items of the last opened {{class|GeoDataDocument|kdeedu|4.x}}.
-It is used by the {{class|GeoRenderPlugin|kdeedu|4.x}} to access the list of vector data to draw it.
+It is used by the {{class|GeoRenderPlugin|kdeedu|4.x}} to access the list of vector data and draw it.
 === QAbstractListModel ===
 * {{class|FileViewModel|kdeedu|4.x}}
-It represents the list of opened files. The {{class|PlacemarkManager|kdeedu|4.x}} appends the documents it opens, and the {{class|MarbleWidget|kdeedu}} appends the gpx files it opens.
+It represents the list of opened files. The {{class|FileManager|kdeedu|4.x}} signals it about the documents it opens or closes.
-It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and manipulated by the {{class|PlaceMarkManager|kdeedu|4.x}} and the {{class|MarbleModel|kdeedu|4.x}}.
+It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and by a List widget in the {{class|MarbleControlBox|kdeedu|4.X}}.
 * {{class|MarbleGeoDataModel|kdeedu|4.x}}
-It represents a list of {{class|GeoDataDocuments|kdeedu|4.x}}. Only the {{class|PlacemarksPlugin|kdeedu|4.x}} uses it
+It represents a list of {{class|GeoDataDocuments|kdeedu|4.x}}. Only the {{class|PlacemarksPlugin|kdeedu|4.x}} uses it.
 It is used by no other code.
 * {{class|MarblePlacemarkModel|kdeedu|4.x}}
-It represents the list of all Placemarks of all opened kml files. the {{class|PlaceMarkManager|kdeedu|4.x}} appends all the placemarks after reading a file.
+It represents a list of Placemarks.
-It is used by the {{class|MarbleControlBox|kdeedu|4.X}} to provide the list of placemarks to search for, and by the {{class|PlacemarkLayout|kdeedu|4.x}} to determine layouting on the map.
+The {{class|PlaceMarkManager|kdeedu|4.x}} appends all the placemarks contained in the {{class|GeoDataDocument|kdeedu|4.x}} it knows about in its instance.

@@ Line 6: / Line 6: @@
 === QAbstractItemModel ===
-* {{class|GeoDataDebugModel|kdeedu}}
+* {{class|GeoDataDebugModel|kdeedu|4.x}}
-It represents a data file, parsed into a {{class|GeoDataDocument|kdeedu}} tree structure.
+It represents a data file, parsed into a {{class|GeoDataDocument|kdeedu|4.x}} tree structure.
-It is used by the {{class|DataViewPlugin|kdeedu}} debug plugin (and is broken atm)
+It is used by the {{class|DataViewPlugin|kdeedu|4.x}} debug plugin (and is broken atm)
 * {{class|GpxFileModel|kdeedu|4.x}}
@@ Line 17: / Line 17: @@
 The model that is in the GpsLayer is currently only being used as a collection class and is deprecated. This, along with the whole current GPX implementation, needs to be removed and updated to the current concepts in Marble. See [[Projects/Marble/GPXStatus|Gpx Status]]
-* {{class|MarbleGeometryModel|kdeedu}}
+* {{class|MarbleGeometryModel|kdeedu|4.x}}
-It represents the {{class|GeoDataGeometry|kdeedu}} and the {{class|GeoDataFeature|kdeedu}} items of the {{class|GeoDataDocument|kdeedu}} which contains all Placemarks.
+It represents the {{class|GeoDataGeometry|kdeedu}} and the {{class|GeoDataFeature|kdeedu|4.x}} items of the {{class|GeoDataDocument|kdeedu|4.x}} which contains all Placemarks.
-It is used by the {{class|GeoRenderPlugin|kdeedu}} to access the list of placemarks.
+It is used by the {{class|GeoRenderPlugin|kdeedu|4.x}} to access the list of placemarks.
 === QAbstractListModel ===
-* {{class|FileViewModel|kdeedu}}
+* {{class|FileViewModel|kdeedu|4.x}}
-It represents the list of files opened. The {{class|PlacemarkManager|kdeedu}} appends the documents it opens, and the {{class|MarbleWidget|kdeedu}} appends the gpx files it opens.
+It represents the list of files opened. The {{class|PlacemarkManager|kdeedu|4.x}} appends the documents it opens, and the {{class|MarbleWidget|kdeedu}} appends the gpx files it opens.
-It is used by the {{class|FileViewFloatItem|kdeedu}} and manipulated by the {{class|PlaceMarkManager|kdeedu}} and the {{class|MarbleModel|kdeedu}}.
+It is used by the {{class|FileViewFloatItem|kdeedu|4.x}} and manipulated by the {{class|PlaceMarkManager|kdeedu|4.x}} and the {{class|MarbleModel|kdeedu|4.x}}.
-* {{class|MarbleGeoDataModel|kdeedu}}
+* {{class|MarbleGeoDataModel|kdeedu|4.x}}
-It represents a list of {{class|GeoDataDocuments|kdeedu}}. Only the {{class|PlacemarksPlugin|kdeedu}} uses it
+It represents a list of {{class|GeoDataDocuments|kdeedu|4.x}}. Only the {{class|PlacemarksPlugin|kdeedu|4.x}} uses it
 It is used by no other code.
-* {{class|MarblePlacemarkModel|kdeedu}}
+* {{class|MarblePlacemarkModel|kdeedu|4.x}}
 It represents
 It is used by

@@ Line 11: / Line 11: @@
 It is used by the {{class|DataViewPlugin|kdeedu}} debug plugin (and is broken atm)
-* {{class|GpxFileModel|kdeedu}}
+* {{class|GpxFileModel|kdeedu|4.x}}
-It represents a list of gpx data file represented as {{class|GpxFile|kdeedu}}
+It represents a list of gpx data file represented as {{class|GpxFile|kdeedu|4.x}}
-It is used by the {{class|GpxLayer|kdeedu}} to load files and access them (and it doesn't look like it needs the Model-specific methods)
+This was originally intended to but used as the model for the File List View ( which is accessible by running marble with --enableFileView ) but has since been replaced by another, more centralised, File Model. This new File Model is located in {{class|PlacemarkManager|kdeedu|4.x}}.
 * {{class|MarbleGeometryModel|kdeedu}}