Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
dev:viewer:sdk:concepts [2020/05/12 16:46] jeroen |
dev:viewer:sdk:concepts [2022/09/28 13:10] (current) pieter |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Technical Concepts | + | ====== |
- | This page describes | + | This page is a glossary describing |
- | + | ||
- | ===== Introduction ====== | + | |
- | + | ||
- | ==== License ==== | + | |
- | + | ||
- | There is no additional cost to get started and to use the Viewer SDK. The right to use the Viewer is managed by Cloud or Publisher via Named or Guest Users. | + | |
- | + | ||
- | ==== Viewer vs Viewer SDK ==== | + | |
- | + | ||
- | you the tools to build a plugin that connects a 3rd party application with the Orbit 3D Mapping Viewer. The connection is a two-way communication set up with WebSockets technology which enables synchronizing, | + | |
- | + | ||
- | + | ||
- | ===== Glossary ===== | + | |
==== Bookmark ==== | ==== Bookmark ==== | ||
Line 24: | Line 11: | ||
* Anyone else can open a Bookmark that is made public, providing the Organisation has enough Guest Users left. | * Anyone else can open a Bookmark that is made public, providing the Organisation has enough Guest Users left. | ||
- | ==== Coordinate | + | ==== Coordinates |
A Coordinate represents an exact geographical location in a specific CRS. | A Coordinate represents an exact geographical location in a specific CRS. | ||
- | ==== Coverage ==== | + | By default, all data returned by the SDK is expressed in WGS84, EPSG: |
- | + | ||
- | Coverage is an overall term to point out vector | + | |
==== Coordinate Reference System ==== | ==== Coordinate Reference System ==== | ||
Line 39: | Line 24: | ||
Spatial objects that are returned by the SDK are expressed in WGS84 (EPSG code 4326) by default. | Spatial objects that are returned by the SDK are expressed in WGS84 (EPSG code 4326) by default. | ||
+ | |||
+ | ==== Coverage ==== | ||
+ | |||
+ | Coverage is an overall term to point out vector data which consists of the Footprints, the Envelope, and the Field of Views of a run. | ||
==== Field Of View ==== | ==== Field Of View ==== | ||
A Field Of View is the representation of the position, direction or bounds of a View on the Reference Map. \\ | A Field Of View is the representation of the position, direction or bounds of a View on the Reference Map. \\ | ||
- | Field-Of-Views are provided by the SDK as MapObjects. | + | Field-Of-Views are provided by the SDK as '' |
==== Footprint ==== | ==== Footprint ==== | ||
- | A Footprint is the representation of a visible Resource on the Reference Map. Footprints are useful to indicate data availability. Footprints can be Photo Positions or the Envelope. \\ | + | A Footprint is the representation of a visible Resource on the Reference Map. Footprints are useful to indicate data availability. Footprints can be Photo Positions, a Trajectory |
Footprints are provided by the SDK as '' | Footprints are provided by the SDK as '' | ||
Line 71: | Line 60: | ||
==== MapObjects ===== | ==== MapObjects ===== | ||
- | A MapObject is an object that defines everything needed to render it on the Reference Map: | + | Visualisation of Data |
- | * Spatial information (point, | + | |
- | * Legend information (line color, etc...) | + | |
- | Currently, there are four types of MapObjects that can be rendered | + | To represent objects to be rendered, we decided on introducing a self-describing type called a '' |
- | * Field-of-views | + | * It describes its own spatial component (point, line, area) |
- | * Measurements | + | * It describes its own legend component (line color, etc...) |
- | * Globals | + | |
- | * Footprints: Visualisation of where resources have data available. | + | |
- | ===== Measurement | + | Currently we have 4 types of MapObjects that are to be rendered in their own layer. |
+ | * Field-of-views : visualisation of view states. | ||
+ | * Measurements : Visualisation of measurements. | ||
+ | * Globals : Visualisation of global state (focus, mouse hover). | ||
+ | * Footprints : Visualisation of where resources have data available. | ||
+ | |||
+ | By using MapObjects, we move the complexity of representing Viewer data out of your code and into the Viewer SDK itself. | ||
+ | |||
+ | ==== Measurement ==== | ||
A Measurement can be a point, line or area you measure. | A Measurement can be a point, line or area you measure. | ||
When making a Measurement, | When making a Measurement, | ||
+ | |||
+ | ==== Pan Angle ==== | ||
+ | |||
+ | The viewing direction of a view in the horizontal plane with 0 degrees indicating north and 90 degrees indicating the east. Pan is similar to the concept of heading in navigation. | ||
==== Publication ==== | ==== Publication ==== | ||
Line 100: | Line 97: | ||
The Reference Map is the 2D map, which is part of the Viewer. It shows you where Resources and Views are situated in the form of Footprints and Field of Views. | The Reference Map is the 2D map, which is part of the Viewer. It shows you where Resources and Views are situated in the form of Footprints and Field of Views. | ||
+ | |||
+ | The '' | ||
+ | The '' | ||
+ | The '' | ||
==== Resource ==== | ==== Resource ==== | ||
Line 107: | Line 108: | ||
==== Signal ==== | ==== Signal ==== | ||
- | A Signal can be best described as an event emitter. | + | A Signal can be best described as an event emitter. |
- | Some signals also provide a payload when they dispatch an event. | + | Signals |
- | + | ||
- | By convention, signal names are CamelCase and always | + | |
==== Start-Up Options ===== | ==== Start-Up Options ===== | ||
Line 118: | Line 117: | ||
One example of such an option is the " | One example of such an option is the " | ||
+ | |||
+ | ==== Tilt Angle ==== | ||
+ | |||
+ | The viewing direction of a view in the vertical plane parallel to the viewing direction. | ||
==== User ==== | ==== User ==== | ||
Line 133: | Line 136: | ||
The Viewer is the framework in which a publication is made and resources are represented. | The Viewer is the framework in which a publication is made and resources are represented. | ||
+ | |||
+ | ==== Viewer3DM ==== | ||
+ | |||
+ | The central Viewer component is named '' | ||
==== Workspace ==== | ==== Workspace ==== |
Last modified:: 2020/05/12 16:46