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/03/31 13:44] nathalie |
dev:viewer:sdk:concepts [2022/09/28 13:10] (current) pieter |
||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== Concepts | + | ====== |
- | ===== Bookmark | + | This page is a glossary describing some basic concepts of the 3DM Viewer and 3DM Viewer SDK. |
+ | |||
+ | ==== Bookmark ==== | ||
A Bookmark is a utility for Named Users that allows them to store a Workspace for later reference. By default, this is a private utility, available from the Bookmark sidebar of the Viewer. | A Bookmark is a utility for Named Users that allows them to store a Workspace for later reference. By default, this is a private utility, available from the Bookmark sidebar of the Viewer. | ||
Line 9: | 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 | + | 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 data which consists of the Footprints, the Bounding Box, and the Field of Views of a run. | + | ==== Coordinate Reference System ==== |
- | + | ||
- | ===== Coordinate Reference System | + | |
A CRS or Coordinate Reference System is a system used to interpret locations of features with the use of their coordinates. For more information on the use of Coordinate Reference Systems in Orbit, please visit [[dev: | A CRS or Coordinate Reference System is a system used to interpret locations of features with the use of their coordinates. For more information on the use of Coordinate Reference Systems in Orbit, please visit [[dev: | ||
Line 25: | Line 25: | ||
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. | ||
- | ===== Field Of View ===== | + | ==== 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 ==== | ||
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 '' | + | A Footprint is the representation of a visible Resource on the Reference Map. Footprints are useful to indicate data availability. |
Footprints are provided by the SDK as '' | Footprints are provided by the SDK as '' | ||
- | ===== Login ===== | + | ==== Globals |
- | When you launch the SDK, you need to Login to a service that will provide the data. The SDK supports both cloud based as on-premise content. | + | Global state (focus, mouse hover). |
- | [[https:// | + | |
- | - Login to 3D Mapping Cloud as [[https:// | + | |
- | - Login to 3DM Publisher : Requires Publisher Url, User and Password. Then choose a Publication. | + | |
- | - Use a token to get access to a 3D Mapping Cloud Publication as [[https:// | + | |
- | It is possible to Preset the login credentials or to use them to login automatically.\\ | + | ==== Login ==== |
- | Preset requires the user to confirm and allows to pick another login option. Auto Login requires no user interaction and disables the option to use another login option. | + | |
- | Note: For security reasons we do not allow the SDK Developer | + | When you launch |
+ | [[https:// | ||
+ | - Login to 3D Mapping | ||
+ | - Login to 3DM Publisher: Requires Publisher Url, User, and Password. Then choose a Publication. | ||
+ | - Use a token to get access to a 3D Mapping Cloud Publication as [[https:// | ||
+ | |||
+ | It is possible to pre-set the login credentials or to use them to log in automatically.\\ | ||
+ | * The preset requires the user to confirm and allows us to pick another login option. | ||
+ | * Auto-Login requires no user interaction and disables the option to use another login option. | ||
- | ===== MapObjects ====== | + | Note: For security reasons, we do not allow the SDK Developer to preset a 3DM Cloud Named User Login. |
- | A '' | + | ==== MapObjects ===== |
- | * Spatial information (point, | + | |
- | * Legend information (line color, etc...) | + | |
- | MapObjects are used throughout the SDK to convey what needs to be rendered on the '' | + | Visualisation |
To represent objects to be rendered, we decided on introducing a self-describing type called a '' | To represent objects to be rendered, we decided on introducing a self-describing type called a '' | ||
Line 69: | Line 74: | ||
By using MapObjects, we move the complexity of representing Viewer data out of your code and into the Viewer SDK itself. | By using MapObjects, we move the complexity of representing Viewer data out of your code and into the Viewer SDK itself. | ||
- | ===== Measurement | + | ==== Measurement ==== |
- | A '' | + | A Measurement can be a point, line or area you measure. |
- | When making a Measurement, | + | When making a Measurement, |
- | As soon as possible, a list of Measurement properties is also made available describing the Measurement (for example: 2d area, slope, ...). | + | ==== Pan Angle ==== |
- | ===== Publication ===== | + | 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. |
- | A '' | + | ==== Publication |
- | ===== Promise ===== | + | A Publication is a representation of Resources in the Viewer. A publication is the end product of the [[dev: |
- | A '' | + | ==== Promise ==== |
+ | |||
+ | A Promise is an object instance that is a placeholder for a value that is not yet available. | ||
The user of a Promise can attach listeners to the Promise to be notified when the Promise either resolves or fails. | The user of a Promise can attach listeners to the Promise to be notified when the Promise either resolves or fails. | ||
- | ===== Reference Map ===== | + | ==== Reference Map ==== |
- | The '' | + | 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 '' | ||
The '' | The '' | ||
+ | ==== Resource ==== | ||
- | ===== Resource ===== | + | A resource is a dataset that can be opened in the Viewer. A resource can be one of the following types: Mobile Mapping run, Oblique project, UAS run, vector data, point cloud, textured mesh. |
- | ===== Signal | + | ==== Signal ==== |
- | A '' | + | A Signal can be best described as an event emitter. |
- | Some signals also provide a '' | + | Signals start with " |
- | By convention, signal names are camel-cased and always start with " | + | ==== Start-Up Options ===== |
- | ===== Start-Up | + | A Start-Up |
- | A '' | + | One example of such an option |
- | One example of such an option is the " | + | ==== Tilt Angle ==== |
- | ===== User ===== | + | The viewing direction of a view in the vertical plane parallel to the viewing direction. |
- | There are 3 types of users, all automatically handled by the SDK (see '' | + | ==== User ==== |
+ | |||
+ | There are 3 types of users, all automatically handled by the SDK (see Log in) | ||
* [[https:// | * [[https:// | ||
* [[https:// | * [[https:// | ||
* 3DM Publisher users | * 3DM Publisher users | ||
- | ===== View ===== | + | ==== View ==== |
+ | |||
+ | A View is a single interactive component of the Viewer Workspace that visualizes the visible Resources, in some way or form. | ||
+ | |||
+ | ==== Viewer | ||
- | A '' | + | The Viewer |
- | ===== Viewer ===== | + | ==== Viewer3DM |
+ | The central Viewer component is named '' | ||
- | ===== Workspace | + | ==== Workspace ==== |
- | A '' | + | A Workspace defines a list of Resources and how they are presented by the Viewer. |
Publications and Bookmarks use a Workspace to store the Viewer state. | Publications and Bookmarks use a Workspace to store the Viewer state. |
Last modified:: 2020/03/31 13:44