Skip to content

Commit 2427531

Browse files
committed
Update documentation
1 parent 92dc1db commit 2427531

File tree

3 files changed

+48
-56
lines changed

3 files changed

+48
-56
lines changed

3dwebclient/splash/SplashWindow.html

+24-20
Original file line numberDiff line numberDiff line change
@@ -187,32 +187,35 @@ <h1>3DCityDB-Web-Map-Client</h1>
187187

188188
<h2 class="milestone">Introduction</h2>
189189
<p>
190-
The <b>3DCityDB-Web-Map-Client</b> is a web-based front-end of the 3DCityDB for high-performance 3D visualization and interactive exploration of <b>arbitrarily large semantic 3D city models in CityGML</b>. It utilizes the <a href="http://cesiumjs.org/index.html" target="_blank">Cesium Virtual Globe</a> as its 3D geo-visualization engine based on HTML5 and Web Graphics Library (WebGL) to provide hardware acceleration and cross-platform functionalities like displaying 3D graphic contents on web browsers without the needs of additional plugins.
190+
The <b>3DCityDB-Web-Map-Client</b> is a web-based front-end of the 3DCityDB for high-performance 3D visualization and interactive exploration of <b>arbitrarily large semantic 3D city models in CityGML</b>. It utilizes the <a href="https://cesium.com/" target="_blank">Cesium Virtual Globe</a> as its 3D geo-visualization engine based on HTML5 and Web Graphics Library (WebGL) to provide hardware acceleration and cross-platform functionalities like displaying 3D graphic contents on web browsers without the needs of additional plugins.
191191
</p>
192192
<p>
193193
The key features and functionalities of the 3DCityDB-Web-Map-Client is summarized as follows:
194194

195195
<ul>
196196
<li>
197-
Support for efficient displaying, caching, prefetching, dynamic loading and unloading of large pre-styled 3D visualization models in the form of tiled KML/glTF datasets exported from the 3DCityDB using the Importer/Exporter
197+
Support for efficient displaying, caching, prefetching, dynamic loading and unloading of large pre-styled 3D visualization models in the form of <b>tiled KML/glTF datasets exported from the 3DCityDB</b> using the Importer/Exporter
198198
</li>
199199
<li>
200-
Intuitive user interface for adding and removing arbitrary number of data layers like 3D visualization model (KML/glTF), WMS imagery layer, and Cesium digital terrain model
200+
Intuitive user interface for adding and removing <b>arbitrary number of data layers</b> for 3D visualization (KML/glTF, GeoJSON, Cesium 3D Tiles, I3S), together with WMS/WMTS imagery layer, and Cesium digital terrain model
201201
</li>
202202
<li>
203-
Support for linking the 3D visualization models (KML/glTF) with the cloud-based Google Fusion Table allowing for querying the thematic data of every 3D object
203+
Support for linking the 3D visualization models (KML/glTF, GeoJSON, Cesium 3D Tiles, I3S) with <b>external thematic data sources</b>, such as <b>Google Spreadsheets</b> and <b>PostgreSQL/PostgREST</b>, allowing for querying the thematic data of every 3D object
204204
</li>
205205
<li>
206-
Support for rich interaction with 3D visualization models (KML/glTF), for example, highlighting of 3D objects on mouseover and mouseclick as well as hiding and showing of the selected 3D objects
206+
Support for displaying the existing <b>thematic data embedded</b> within the visualization datasets, such as KML, GeoJSON, Cesium 3D Tiles and I3S
207207
</li>
208208
<li>
209-
Support for exploring a 3D object of interest from different view perspectives using third-party mapping services like Microsoft Bing Maps with oblique view, Google Streetview, and a combined version (DualMaps)
209+
Support for rich interaction with 3D visualization models, for example, <b>highlighting</b> of 3D objects on mouseover and mouseclick as well as <b>hiding</b> and <b>showing</b> of multiple selected 3D objects
210210
</li>
211211
<li>
212-
Support for on-the-fly activating and deactivating shadow visualization of 3D objects (only for glTF, KML is currently not supported yet) and Cesium digital terrain models
212+
Support for exploring a 3D object of interest from <b>different view perspectives</b> using third-party mapping services like <b>Microsoft Bing Maps</b> with oblique view, <b>Google Streetview</b>, and a combined version (<b>DualMaps</b>)
213213
</li>
214214
<li>
215-
Support for collaborative creation and sharing of the workspace of the 3DCityDB-Web-Map-Client by means of generating a scene link including information about the current camera perspective, activation status of the shadow visualization, parameters of the current loaded data layers etc.
215+
Support for on-the-fly activating and deactivating <b>shadow visualization</b> of 3D objects and Cesium digital terrain models
216+
</li>
217+
<li>
218+
Support for collaborative creation and sharing of the workspace of the 3DCityDB-Web-Map-Client by means of <b>generating a scene link</b> including information about the current camera perspective, activation status of the shadow visualization, parameters of the current loaded data layers, etc.
216219
</li>
217220
</ul>
218221
</p>
@@ -226,21 +229,22 @@ <h2 class="milestone">License</h2>
226229
</p>
227230

228231
<h2 class="milestone">Latest release</h2>
229-
<p>
230-
The latest stable release of the 3DCityDB-Web-Map-Client is <samp>1.7.1</samp>.
231232
<p>
232233
All releases are available from the <a href="https://github.com/3dcitydb/3dcitydb-web-map/releases" target="_blank">releases section</a>.
233234
</p>
234235
<p>
235-
For convenient use, there is an official <a href="https://www.3dcitydb.org/3dcitydb-web-map/1.7.1/3dwebclient/index.html" target="_blank">web link</a> available that can be called to directly run the 3DCityDb-Web-Map-Client on your web browser.
236+
This project is also available in Docker, see <a href="https://github.com/tum-gis/3dcitydb-web-map-docker" target="_blank">repository</a> and <a href="https://hub.docker.com/r/tumgis/3dcitydb-web-map/tags?page=1&ordering=last_updated" target="_blank">Docker images</a>.
237+
</p>
238+
<p>
239+
For convenient use, there is an official <a href="https://www.3dcitydb.org/3dcitydb-web-map/latest/3dwebclient/index.html" target="_blank">web link</a> available that can be called to directly run the 3DCityDb-Web-Map-Client on your web browser.
236240
</p>
237241

238242
<h2 class="milestone">System requirements</h2>
239243
<p>
240244
The hardware on which the 3DCityDB-Web-Map-Client will be run must have a graphics card installed that supports WebGL. In addition, the web browser in use must also provide appropriate WebGL support.
241245
</p>
242246
<p>
243-
You can visit the <a href="http://get.webgl.org/](http://get.webgl.org/" target="_blank">WebGL website</a> to check whether your web browser supports WebGL.
247+
You can visit the <a href="http://get.webgl.org](http://get.webgl.org" target="_blank">WebGL website</a> to check whether your web browser supports WebGL.
244248
</p>
245249
<p>
246250
The 3DCityDB-Web-Map-Client has been successfully tested on (but is not limited to) the following web browsers under different desktop operating systems like Microsoft Windows, Linux, Apple Mac OS X, and even on mobile operating systems like Android and iOS.
@@ -272,13 +276,13 @@ <h2 class="milestone">Contributing</h2>
272276
<p>
273277
<ul>
274278
<li>
275-
To file bugs found in the software create a GitHub issue.
279+
To report bugs found in the software, please create a GitHub issue.
276280
</li>
277281
<li>
278-
To contribute code for fixing filed issues create a pull request with the issue id.
282+
To contribute code for fixing issues, please create a pull request with the issue id.
279283
</li>
280284
<li>
281-
To propose a new feature create a GitHub issue and open a discussion.
285+
To propose a new feature, please also create a GitHub issue and open a discussion.
282286
</li>
283287
</ul>
284288
</p>
@@ -288,19 +292,19 @@ <h2 class="milestone">Developers</h2>
288292
The 3DCityDB-Web-Map-Client has been developed by:
289293
<ul>
290294
<li>
291-
Zhihang Yao, Son H. Nguyen, Kanishk Chaturvedi, and Thomas H. Kolbe
295+
Son H. Nguyen, Kanishk Chaturvedi, and Thomas H. Kolbe
292296
<br>
293-
<a href="https://www.gis.bgu.tum.de/" target="_blank">Chair of Geoinformatics, Technical University of Munich</a>
297+
<a href="https://www.asg.ed.tum.de/en/gis" target="_blank">Chair of Geoinformatics, Technical University of Munich</a>
294298
</li>
295299
</ul>
296300
</p>
297301
<p>
298302
and with the support from the following cooperation partners:
299303
<ul>
300304
<li>
301-
Jannes Bolling, Lucas van Walstijn, and Claus Nagel
305+
Zhihang Yao, Jannes Bolling, Lucas van Walstijn, and Claus Nagel
302306
<br>
303-
<a href="https://www.virtualcitysystems.de/" target="_blank">virtualcitySYSTEMS GmbH, Berlin</a>
307+
<a href="https://vc.systems" target="_blank">Virtual City Systems, Berlin</a>
304308
</li>
305309
</ul>
306310
</p>
@@ -317,4 +321,4 @@ <h2 class="milestone">More information</h2>
317321
</article>
318322

319323
</body>
320-
</html>
324+
</html>

0 commit comments

Comments
 (0)