Skip to content

Commit abfac22

Browse files
committed
Rewrite docs
1 parent 2472b86 commit abfac22

File tree

5 files changed

+286
-173
lines changed

5 files changed

+286
-173
lines changed

.gitattributes

+1-4
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
# Set default behavior to automatically normalize line endings.
33
###############################################################################
44
* text=auto
5-
65
###############################################################################
76
# Set default behavior for command prompt diff.
87
#
@@ -11,7 +10,6 @@
1110
# Note: This is only used by command line
1211
###############################################################################
1312
#*.cs diff=csharp
14-
1513
###############################################################################
1614
# Set the merge driver for project and solution files
1715
#
@@ -34,7 +32,6 @@
3432
#*.modelproj merge=binary
3533
#*.sqlproj merge=binary
3634
#*.wwaproj merge=binary
37-
3835
###############################################################################
3936
# behavior for image files
4037
#
@@ -43,7 +40,6 @@
4340
#*.jpg binary
4441
#*.png binary
4542
#*.gif binary
46-
4743
###############################################################################
4844
# diff behavior for common document formats
4945
#
@@ -61,3 +57,4 @@
6157
#*.PDF diff=astextplain
6258
#*.rtf diff=astextplain
6359
#*.RTF diff=astextplain
60+
docs/demos/* filter=lfs diff=lfs merge=lfs -text

README.md

+67-41
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,98 @@
11
# Atlas
22

3-
Atlas is a GIS visualization project that aims to combine some basic features of [QGIS](https://qgis.org/en/site/) and [Google Earth](https://www.google.com/earth/). It utilizes [OpenSceneGraph (OSG)](http://www.openscenegraph.org/) and [OSGEarth](http://osgearth.org/) to handle 2D maps and 3D models in the same space. It depends on [Qt](https://www.qt.io/) to provide a friendly and easy-to-extend UI and provides a convenient plugin system so that all kinds of extensions can be implemented easily.
3+
Atlas is a 3D GIS visualization project that aims to combine some basic features of [QGIS](https://qgis.org/en/site/) and [Google Earth](https://www.google.com/earth/). It utilizes [osgEarth](http://osgearth.org/) to handle 2D maps and 3D models in the same space. It depends on [Qt 5](https://www.qt.io/) to provide an customizable UI and provides a strong plugin system.
44

5-
The main purpose of the project is to provide fancier visualization of geographic applications, while supporting some complicated analysis tasks and more advanced research purposes.
5+
The main purpose of the project is to provide fancier and easier visualization of geographic applications, while supporting complicated analysis tasks and more advanced research purposes.
66

7-
It currently supports Windows 7 x64 and above systems.
7+
It has been tested on Windows 10, Fedora 28 and ubuntu 16.04.
88

99
[中文版说明](docs/README.cn.md)
1010

11-
## Demos
11+
## Features
1212

13-
The project is still under development, but a [development release](https://drive.google.com/open?id=10lZnGS43kjEyBusYYlvUROLRjjqIqwvH) is provided so you can have a taste of it. If you are interested to contribute, please see [Call for Contributors](#call-for-contributors) section below.
13+
### Large Scale 3D Models
1414

15-
A simple video demonstration:
15+
Improved performance, interaction, and various analysis and measurement tools for:
1616

17-
## Main Features
17+
* [Oblique Imagery](https://www.eagleview.com/product/pictometry-imagery/oblique-imagery/) model
18+
* dense point cloud
19+
* other models supported by [OSG](http://www.openscenegraph.org/index.php/documentation/user-guides/61-osgplugins)
1820

19-
1. __Large Scale 3D Models__
20-
Atlas handles large scale real world models like [Oblique Imagery](https://www.eagleview.com/product/pictometry-imagery/oblique-imagery/), dense point clouds and city-scale model group. Using LOD technology, models with great sizes and high resolutions can be viewed with better user experience. Useful GIS oriented tools like measurements, visibility analysis, ortho imagery generation and model editing are shipped with friendly UI.
21+
### Geographic Data
2122

22-
2. __Mixing Geographic Data__
23-
Most formats of traditional data are supported and fused together, such like local and online maps, terrains and geo-features. They can be managed in a uniform way, shown in the same space and interact with each other. Complicated scene structure, rendering strategy and data analysis can be achieved though our various plugins.
23+
Common geographic data formats and services are supported and fused together in the 3D space.
2424

25-
3. __Multiple Formats__
26-
Theoretically, all data formats supported by OSG and OSGEarth can be utilized in the program. Other data formats can also be supported by means of plugins. Typical formats include: geographic images, map services and 3D models. A full list can be found [here](http://www.openscenegraph.org/index.php/documentation/user-guides/61-osgplugins) and [here](http://docs.osgearth.org/en/latest/data.html).
25+
* local files: see [GDAL raster](https://www.gdal.org/formats_list.html) and [GDAL ogr](https://www.gdal.org/ogr_formats.html)
26+
* raster services: XYZ tiles, TMS, WMS, ArcGIS services
27+
* vector services: WFS, ArcGIS services
2728

28-
4. __Fully Pluggable__
29-
Thanks to Qt, a plugin system is implemented as a core component of Atlas. Plugins compiled under the same environment as the main program can just drop-and-run. Plugins are given quite a lot of freedom, so there is little limit on what you can do with plugins.
29+
### Coherent Data Api
3030

31-
## Plugin List
31+
Atlas provides a high level and uniform api for different data formats supported by OSG, osgEarth and custom plugins. For supported data formats please see:
3232

33-
All current plugins are listed at [plugins.md](docs/plugins.md).
33+
* [OpenSceneGraph](http://www.openscenegraph.org/index.php/documentation/user-guides/61-osgplugins) formats
34+
* [osgEarth](http://docs.osgearth.org/en/latest/data.html) formats
35+
* [plugin extensions](docs/plugins.md)
3436

35-
## Call for Contributors
37+
### Highly Extensible
3638

37-
This project is at a very early stage. The core code is far from being mature or stable, and the plugins need testing and maintenance. Also, since the project aims to mimic QGIS and Google Earth, more functionalities (plugins) are urgently and consistently needed.
39+
Atlas is built upon plugins. It is easy to add new features to the main program or modify the existing behaviours with the help of plugins.
3840

39-
If you are interested in or skilled at any of the following topics, we are most delightful if you can become a contributor:
41+
A full list of current plugins can be found at [plugins.md](docs/plugins.md).
4042

41-
* skills: C++, Qt, OSG, OSGEarth
42-
* development topics: desktop app, visualization, UI
43-
* research interest: GIS, CG, CV
43+
## Demos
4444

45-
You can get started by:
45+
The project is still under development, but a [development release](https://drive.google.com/open?id=10lZnGS43kjEyBusYYlvUROLRjjqIqwvH) is provided so you can have a taste of it.
4646

47-
* try out the [dev release](https://drive.google.com/open?id=10lZnGS43kjEyBusYYlvUROLRjjqIqwvH)
48-
* [building the project](docs/build_guide.md)
49-
* read the [project structure](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372)
50-
* find your interested task in [ToDo List](https://trello.com/b/Z7r1N9yJ) or put up a new idea
51-
* fork the project, finish coding and commit a PR
47+
Geodetic & projected modes
5248

53-
If you want to write a new plugin, see [plugin_guide.md](docs/plugin_guide.md).
49+
Online images & terrains
50+
51+
Oblique imagery models
52+
53+
Draw & measure
54+
55+
Data management
56+
57+
Visibility test
58+
59+
Crowd simulation
5460

55-
You are welcome to give comments on issues page, or just contact me via [email protected]. We manage the project progress on [trello](https://trello.com/b/Z7r1N9yJ) where you can also request for features and report bugs.
61+
Slope grade visualization
5662

57-
## Todo List
63+
Plan comparison (by editing oblique model)
5864

59-
See __"To Do"__ card on [trello board](https://trello.com/b/Z7r1N9yJ).
65+
Orthographic generation (for oblique model)
66+
67+
## Contribute
68+
69+
This project is at a *very early* stage. The core code is far from being mature or stable, and the plugins need testing and maintenance. Also, since the project aims to mimic QGIS and Google Earth, more functionalities (plugins) are urgently and consistently needed.
70+
71+
If you are interested in or skilled at any of the following topics, we are most delightful if you can become a contributor:
72+
73+
* skills: C++, Qt, OSG, OSGEarth, OpenGL
74+
* topics: desktop app, visualization, UI
75+
* research: GIS, CG, CV
76+
77+
### Getting started
78+
79+
1. try out the [dev release](https://drive.google.com/open?id=10lZnGS43kjEyBusYYlvUROLRjjqIqwvH)
80+
2. [build from source](docs/build_guide.md)
81+
3. read the [project structure](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372)
82+
4. find your interested task on [trello board](https://trello.com/b/Z7r1N9yJ) or put up a new idea
83+
5. fork the project, finish coding and commit a PR
84+
85+
If you want to write a new plugin, see [plugin_guide.md](docs/plugin_guide.md).
6086

61-
# On Linux
62-
This Fork work on linux with cmake
87+
### Dev Resources
6388

64-
mkdir build
65-
cd build
66-
cmake-gui ../ #Select Plugins ...
89+
* [trello board](https://trello.com/b/Z7r1N9yJ)
90+
* [build guide](docs/build_guide.md)
91+
* [plugin guide](docs/plugin_guide.md)
92+
* [project structure](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372)
6793

68-
make
94+
## Contact
6995

70-
## Development
96+
You are welcome to give feedbacks on [issues](../../issues) page, or just contact us via [email protected].
7197

72-
See [build_guide.md](docs/build_guide.md), [plugin_guide.md](docs/plugin_guide.md) and [project structure](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372).
98+
We manage the project progress on [trello](https://trello.com/b/Z7r1N9yJ) where you can also request for features and report bugs.

docs/README.cn.md

+61-26
Original file line numberDiff line numberDiff line change
@@ -1,63 +1,98 @@
11
# Atlas
22

3-
Atlas 是一个三维地图可视化分析项目。Atlas 结合了 [QGIS](https://qgis.org/en/site/)[谷歌地球](https://www.google.com/earth/) 的主要特性,利用 [OpenSceneGraph (OSG)](http://www.openscenegraph.org/) 引擎和 [OSGEarth](http://osgearth.org/) 来将二维地图和三维模型展示在同一三维空间内。程序使用 [Qt](https://www.qt.io/) 作为框架,以提供简洁、可定制的 UI,并且实现了一个高扩展性的插件系统,允许用户在不需要了解核心源码的情况下,轻松开发各种新功能,或是定制和修改现有的特性
3+
Atlas 是一个三维地图可视化分析项目。Atlas 结合了 [QGIS](https://qgis.org/en/site/)[谷歌地球](https://www.google.com/earth/) 的主要特性,利用 [osgEarth](http://osgearth.org/) 来将二维地图和三维模型展示在同一三维空间内。程序使用 [Qt](https://www.qt.io/) 作为框架,以提供简洁、可定制的 UI,并且实现了一个高扩展性的插件系统。
44

55
该项目的主要目的是为地理应用提供更好的可视化解决方案,并在此基础上支持复杂的空间分析、数据处理等,以方便工程应用和学术研究。
66

7-
该程序目前支持Windows 7 x64及以上的系统
7+
该程序在 Windows 10, Fedora 28, Ubuntu 16.04 系统上测试通过
88

99
[English Version](../README.md)
1010

11+
## 主要特性
12+
13+
### 实景三维模型
14+
15+
为大规模三维模型提供渲染性能和交互方面的优化,并实现多种测量和分析工具:
16+
17+
* [倾斜摄影模型](https://www.eagleview.com/product/pictometry-imagery/oblique-imagery/)
18+
* 点云模型
19+
* [OSG](http://www.openscenegraph.org/index.php/documentation/user-guides/61-osgplugins)支持的其他模型格式
20+
21+
### 融合地理数据
22+
23+
支持常见地理数据,并在三维空间中融合渲染:
24+
25+
* 本地数据: GDAL支持的所有[栅格格式](https://www.gdal.org/formats_list.html)[矢量格式](https://www.gdal.org/ogr_formats.html)
26+
* 在线栅格服务: 通用切片服务, TMS, WMS, WCS, ArcGIS服务
27+
* 在线矢量服务: WFS, ArcGIS服务
28+
29+
### 统一数据接口
30+
31+
为不同数据格式提供统一的高层调用接口,封装数据引擎和驱动的API:
32+
33+
* [osg](http://www.openscenegraph.org/index.php/documentation/user-guides/61-osgplugins) 支持格式
34+
* [osgEarth](http://docs.osgearth.org/en/latest/data.html) 支持格式
35+
* [插件](docs/plugins.md) 扩展格式
36+
37+
### 高度可扩展
38+
39+
本程序的大部分功能都由插件实现。使用插件,可以轻易实现新的功能,或是修改现有的功能。
40+
41+
当前所有插件列表:[plugins.md](docs/plugins.md)
42+
1143
## Demo
1244

13-
该项目正在开发中,但我们提供一个 [开发者版本](https://pan.baidu.com/s/17LA7XGeUsZpzTZdLmpRWNw) 以供用户和开发者初步了解它的功能和效果。如果你有兴趣成为项目贡献者,请参见下面的 [征集开发者](#征集开发者) 小节。
45+
该项目正在开发中,但我们提供一个 [开发者版本](https://pan.baidu.com/s/17LA7XGeUsZpzTZdLmpRWNw) 以供用户和开发者初步了解它的功能和效果。
1446

15-
一个简单的视频 demo:
47+
地球模式与投影模式
1648

17-
## 主要特性
49+
倾斜摄影模型
1850

19-
1. __大规模三维模型__
20-
Atlas 可以处理大规模三维模型,如[倾斜摄影模型](https://www.eagleview.com/product/pictometry-imagery/oblique-imagery/),密集点云和城市级模型规划群。通过使用LOD技术,可以为大尺寸高清晰度的模型提供更流畅的交互体验。同时,基于实际地理坐标,提供了包括测量、视域分析、正射影像生成、模型编辑等实用工具。
51+
绘制与测量
2152

22-
2. __融合地理数据__
23-
Atlas 支持主流的地理数据格式,并将融合,其包括地理影像,地图切片,高程图,矢量特征,以及它们所对应的在线服务,如 WMS,WTS,WFS,TMS 等等。程序将这些数据准确合理地渲染在同一个三维空间中,并且为不同数据提供了统一的接口,从而允许用户自由叠加复杂的图层结构,实现分析或展示的需要。
53+
数据管理
2454

25-
3. __广泛格式支持__
26-
理论上,OSG 和 OSGEarth 支持的所有格式的数据,本项目都能够支持。此外,其他的数据格式也可以通过插件的方式获得支持。本项目支持的数据类型涵盖:地理数据,倾斜摄影模型,常见三维模型等。在 [这里](http://www.openscenegraph.org/index.php/documentation/user-guides/61-osgplugins)[这里](http://docs.osgearth.org/en/latest/data.html) 可以看到完整的格式列表。
55+
视域分析
2756

28-
4. __高度可扩展__
29-
本程序通过高兼容性和扩展性的插件系统,实现了完全的插件化。在互相兼容的环境下编译的插件,放在程序的指定目录下就可以自动被加载。同时,插件被赋予了很高的权限,可以访问大部分的数据和UI,因此程序员可以不受限制地开发复杂的功能。
57+
人群仿真
3058

31-
## 插件列表
59+
坡度可视化
3260

33-
[当前所有插件列表](plugins.md)
61+
规划对比(编辑倾斜模型)
62+
63+
正射影像生成(倾斜模型)
3464

3565
## 征集开发者
3666

37-
本项目仍处于十分早期的阶段。核心代码还不成熟,目前已有的插件也需要测试和维护。同时,作为一个三维分析软件,我们急切并长期需要开发者和研究人员为程序提供新的功能(插件)。
67+
本项目仍处于*十分早期*的阶段。核心代码还不成熟,目前已有的插件也需要测试和维护。同时,作为一个三维分析软件,我们急切并长期需要开发者和研究人员为程序提供新的功能(插件)。
3868

3969
如果你擅长、或对以下任何话题感兴趣,我们将十分欢迎你成为项目的贡献者:
4070

4171
* 技能:C++,Qt,OSG,,OSGEarth,OpenGL
4272
* 专题:桌面应用,可视化,界面设计,人机交互
4373
* 研究:GIS,CG,CV
4474

75+
### 开发步骤
76+
4577
你可以从以下步骤开始,参与本项目的开发:
4678

47-
* 试用[开发者版本](https://pan.baidu.com/s/17LA7XGeUsZpzTZdLmpRWNw)
48-
* [编译源码](docs/build_guide.md)
49-
* 了解[项目结构](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372)
50-
* 浏览[任务列表](https://trello.com/b/Z7r1N9yJ),选择感兴趣的任务或提出新想法
51-
* Fork本项目,实现代码,并提交一个PR
79+
1. 试用[开发者版本](https://pan.baidu.com/s/17LA7XGeUsZpzTZdLmpRWNw)
80+
2. [编译源码](docs/build_guide.md)
81+
3. 了解[项目结构](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372)
82+
4. 浏览[任务列表](https://trello.com/b/Z7r1N9yJ),选择感兴趣的任务或提出新想法
83+
5. Fork本项目,实现功能后提交一个Pull Request
5284

5385
如果你希望编写插件,可以参考 [插件教程](docs/plugin_guide.md)
5486

55-
请在 issues 页面提出你的意见, 或直接联系我 [email protected]。我们在 [trello](https://trello.com/b/Z7r1N9yJ) 上管理项目进展,你也可以在上面提出需求和反馈。
87+
### 开发资源
5688

57-
## 任务列表
89+
* [项目管理页面(trello)](https://trello.com/b/Z7r1N9yJ)
90+
* [编译教程](docs/build_guide.md)
91+
* [插件教程](docs/plugin_guide.md)
92+
* [项目结构](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372)
5893

59-
请查看 [trello 面板](https://trello.com/b/Z7r1N9yJ) 中的 To Do 卡片
94+
## 联系我们
6095

61-
## 开发教程
96+
请在 [issues](../../../issues) 页面提出你的意见, 或直接联系 [email protected]
6297

63-
请见 [编译](docs/build_guide.md)[开发插件](docs/plugin_guide.md)[项目结构](https://www.mindomo.com/mindmap/63290a5a387b4e1a85ad713953be0372)
98+
我们在 [trello](https://trello.com/b/Z7r1N9yJ) 上管理项目进展,你也可以在上面提出需求和反馈。

0 commit comments

Comments
 (0)