Skip to content

Commit cf30e37

Browse files
mgermeriegchoqueux
authored andcommitted
tutorial(Fundamentals): add links to documentation
1 parent 7ea6538 commit cf30e37

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/tutorials/Fundamentals.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ In this tutorial, we shall be introduced to the fundamentals of iTowns : how it
99

1010
## Data visualization with iTowns
1111

12-
The support to display anything within iTowns is called a `View`.
12+
The support to display anything within iTowns is called a `{@link View}`.
1313

14-
To provide geographic data visualization, a `View` contains a combination of `Layers` which, in a digital map environment, are visual representations of any geographic data.
14+
To provide geographic data visualization, a `{@link View}` contains a combination of [`Layers`]{@link Layer} which, in a digital map environment, are visual representations of any geographic data.
1515
In other words, all data that are displayed using iTowns are supported by some `Layer`.
1616

1717
Each `View` in iTowns displays 3D data in a unique Coordinates Reference System (CRS).
1818
Yet, the data displayed within a `View` do not necessarily have to be in the `View`'s CRS.
19-
ITowns comes with two pre-made `View` types : `GlobeView` and `PlanarView`.
19+
ITowns comes with two pre-made `View` types : `{@link GlobeView}` and `{@link PlanarView}`.
2020
Each of these allows visualizing data from different types (raster or vector) and from different CRS.
2121
On this matter, iTowns distinguishes two cases :
2222

@@ -47,15 +47,15 @@ Regarding data formats, iTowns offers several possibilities : [vector tile](http
4747

4848
## The support for visualized data
4949

50-
It was earlier mentioned that data are displayed as `Layers` within iTowns.
50+
It was earlier mentioned that data are displayed as [`Layers`]{@link Layer} within iTowns.
5151
Several specific types of `Layers` exist, the use of which depends on the data to display :
5252

53-
- `ColorLayer` can be used to display raster graphics or vector data projected on the ground (left picture in the table bellow),
54-
- `ElevationLayer` can be used to display 3D elevation models (center picture in the table bellow),
55-
- `GeometryLayer` can be used to display 3D objects, such as geometric shapes or buildings modelling (right picture in the table bellow).
56-
- `FeatureGeometryLayer` is a pre-configured `GeometryLayer` which simplifies its implementation in given cases.
57-
- `PointCloudLayer` can be used to display 3D point clouds.
58-
- `OrientedImageLayer` can be used to display some oriented images.
53+
- `{@link ColorLayer}` can be used to display raster graphics or vector data projected on the ground (left picture in the table bellow),
54+
- `{@link ElevationLayer}` can be used to display 3D elevation models (center picture in the table bellow),
55+
- `{@link GeometryLayer}` can be used to display 3D objects, such as geometric shapes or buildings modelling (right picture in the table bellow).
56+
- `{@link FeatureGeometryLayer}` is a pre-configured `{@link GeometryLayer}` which simplifies its implementation in given cases.
57+
- `{@link PointCloudLayer}` can be used to display 3D point clouds.
58+
- `{@link OrientedImageLayer}` can be used to display some oriented images.
5959

6060

6161
| ![color layer](images/Fundamentals-1.png) | ![elevation layer](images/Fundamentals-2.png) | ![geometry layer](images/Fundamentals-3.png) |
@@ -66,14 +66,14 @@ Several specific types of `Layers` exist, the use of which depends on the data t
6666

6767
## Vector data appearance
6868

69-
ITowns can display vector data in two ways : the data can be displayed in a `View` as 3D objects, or as entities that are projected on the ground.
69+
ITowns can display vector data in two ways : the data can be displayed in a `{@link View}` as 3D objects, or as entities that are projected on the ground.
7070
You can see bellow pictures illustrating the two cases.
7171

7272
| ![flattened vector data](images/Fundamentals-4.png) | ![3d vector data](images/Fundamentals-5.png) |
7373
| :---: | :---: |
7474
| Vector data projected on the ground | Vector data display as 3D objects |
7575

76-
In both ways, the appearance and positioning of the vector data can be adjusted by modifying the `Style` parameter of the `Layer` the data are displayed in.
76+
In both ways, the appearance and positioning of the vector data can be adjusted by modifying the `{@link Style}` parameter of the `Layer` the data are displayed in.
7777
The `Style` in iTowns comes with several properties :
7878
- `fill` allows defining style rules for polygons interior,
7979
- `stroke` allows defining style rules for lines and polygons edges,
@@ -98,17 +98,17 @@ The content of the label will be the content stored in the data under the `name`
9898

9999
### Vector data projected on the ground
100100

101-
When vector data are flattened on the ground, they are displayed in a `ColorLayer`.
101+
When vector data are flattened on the ground, they are displayed in a `{@link ColorLayer}`.
102102
In that case, the data basically consist in polygons, lines or points.
103-
Their appearance can be adjusted by modifying the `Style` of the `ColorLayer`.
103+
Their appearance can be adjusted by modifying the `{@link Style}` of the `{@link ColorLayer}`.
104104
Yet, their positioning can't be modified since it is computed so that tey appear projected on the ground.
105105

106106
Tutorial on how to modify the appearance of some vector data displayed on the ground can be found [here]{@tutorial Vector-data-on-ground}.
107107

108108
### Vector data displayed as 3D objects
109109

110-
In the case of vector data represented as 3D objects, the data are displayed in a `GeometryLayer`.
111-
The appearance and positioning of the vector data can be adjusted by modifying the `Style` of the `GeometryLayer`.
110+
In the case of vector data represented as 3D objects, the data are displayed in a `{@link GeometryLayer}`.
111+
The appearance and positioning of the vector data can be adjusted by modifying the `{@link Style}` of the `{@link GeometryLayer}`.
112112
Two parameters allow modifying the data position :
113113
- `base_altitude` which defines the altitude at the base of the 3D objects ;
114114
- `extrusion_height` which defines the height of the 3D objects, giving them volume.

0 commit comments

Comments
 (0)