Skip to content

Commit 4efdac1

Browse files
committed
Documentation improved.
1 parent 657ac70 commit 4efdac1

File tree

1 file changed

+28
-26
lines changed

1 file changed

+28
-26
lines changed
Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,39 @@
11
<body>
22
<html>
33
<p>The <code>aimax.osm</code> package together with its sub-packages contain a
4-
tool for reading, maintaining, and viewing Open Street Map (OSM) data. The viewer is
5-
designed as an efficient general purpose viewer which is highly configurable and
6-
extendible. The internal map representation is chosen as close as possible to the
7-
original OSM XML file format. A kd-tree is used to improve rendering efficiency.
8-
Classification and abstraction of map entities as well as their
9-
visual appearance within the drawn map are controlled by declarative
10-
rendering rules. They can be replaced or configured at runtime.
11-
New personal map styles can be created quite easily. See classes
12-
<code>aimax.osm.viewer.MapStyleFactory</code> and
13-
<code>aimax.osm.application.OsmViewerPlusApp</code> for ideas how that can be
14-
achieved.
4+
tool for reading, maintaining, and viewing Open Street Map (OSM) data. Two GUIs are provided:
5+
One based on JavaFX (package <code>aimax.osm.gui.fx</code>) and the other based on
6+
Swing (package <code>aimax.osm.gui.swing</code>).
7+
The viewer is designed as an efficient general purpose viewer which is highly configurable and
8+
extendible. The internal map representation is chosen as close as possible to the
9+
original OSM XML file format. A kd-tree is used to improve rendering efficiency.
10+
Classification and abstraction of map entities as well as their
11+
visual appearance within the drawn map are controlled by declarative
12+
rendering rules. They can be replaced or configured at runtime.
13+
New personal map styles can be created quite easily. See classes
14+
<code>aimax.osm.viewer.MapStyleFactory</code> and
15+
<code>aimax.osm.gui.swing.application.OsmViewerPlusApp</code> for ideas how that can be
16+
achieved.
1517

1618
<p>Routing functionality is based on the AIMA-JAVA core library.
17-
All dependencies to the core library are encapsulated in the routing
18-
sub-package and the applications using functionality from that package.
19-
So the viewer classes can also be used as stand-alone library
20-
for building general OSM applications.</p>
19+
All dependencies to the core library are encapsulated in the routing
20+
sub-package and the applications using functionality from that package.
21+
So the viewer classes can also be used as stand-alone library
22+
for building general OSM applications.</p>
2123

2224
<p> In the current version, relation entities are ignored and
23-
the size of the map should be limited to about a million nodes
24-
to avoid long loading times. The tool Osmosis can be used to generate
25-
maps complying to this requirement.</p>
25+
the size of the map should be limited to about a million nodes
26+
to avoid long loading times. The tool Osmosis can be used to generate
27+
maps complying to this requirement.</p>
2628

2729
<p> Getting started: Compile the project and run one of the applications
28-
in the <code>aimax.osm.applications</code> package. If no map is displayed
29-
by default, make sure that the main/resource folder is included in
30-
the build path of your project, recompile and start again.
31-
Then place the mouse inside the map viewer pane. Try mouse-left, mouse-right,
32-
mouse-drag, ctrl-mouse-left, plus button, minus button, ctrl-plus, ctrl-minus,
33-
space, ctrl-space, arrow buttons, and also the mouse-wheel for navigation,
34-
mark setting, and track definition. Before routing, at least two marks
35-
must be set!</p>
30+
in the <code>aimax.osm.gui.fx.applications</code> package. If no map is displayed
31+
by default, make sure that the main/resource folder is included in
32+
the build path of your project, recompile and start again.
33+
Then place the mouse inside the map viewer pane. Try mouse-left, mouse-right,
34+
mouse-drag, ctrl-mouse-left, plus button, minus button, ctrl-plus, ctrl-minus,
35+
space, ctrl-space, arrow buttons, and also the mouse-wheel for navigation,
36+
mark setting, and track definition. Before routing, at least two markers
37+
must be set!</p>
3638
</html>
3739
</body>

0 commit comments

Comments
 (0)