@vcmap/viewshed 2.0.10 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,10 @@
1
+ # v3.0.0
2
+
3
+ - updates @vcmap/core and @vcmap/ui to 6.x
4
+ - disables jump to viewpoint if movementApiCallsDisabled is true for activeMap
5
+ - fixes bug where shadowMap not updating when changing field of view
6
+ - naming of state parameters changed (mode is now m; currentViewshed is now cv;)
7
+
1
8
  # v2.0.10
2
9
 
3
10
  - fix link to help document
package/README.md CHANGED
@@ -1,4 +1,19 @@
1
1
  # @vcmap/viewshed
2
2
 
3
3
  > Part of the [VC Map Project](https://github.com/virtualcitySYSTEMS/map-ui)
4
- > describe your plugin
4
+
5
+ Tool to simulate a \"viewer\" and their field of vision from a certain standpoint in the map. It allows the user to see which areas and buildings can or can't be seen from a specific standpoint, regarding different viewing distances, viewers' sizes and orientations.
6
+ There are two different modes available:
7
+
8
+ - The cone viewshed mode is directional, this allows the viewing direction to be determined in addition to the viewer’s viewpoint and distance, the analysis area is limited by the field of view.
9
+ - In 360° viewshed mode, an all-round analysis is performed. Only the viewpoint and a distance that determines the analysis area are selected.
10
+
11
+ ## Configuration
12
+
13
+ To add and configure the plugin add an entry with name @vcmap/viewshed to the map's config plugins section. Below the possible configuration options and their defaults are listed.
14
+
15
+ | key | type | default | description |
16
+ | ------------ | ------------------------ | ----------------- | ----------------------------------------------------------------------- |
17
+ | tools | `Array<'cone' \| '360'>` | `['cone', '360']` | The tools/modes that should be added to the map. |
18
+ | shadowColor | `string` | `#3333331A` | The color of areas that **can not** be seen from the "viewers" position |
19
+ | visibleColor | `string` | `FF990080` | The color of areas that **can** be seen from the "viewers" position |