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:11] 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. |
- | A '' | + | ==== 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. | ||
Bookmarks can also be opened by anyone with the Bookmark' | Bookmarks can also be opened by anyone with the Bookmark' | ||
* All Named Users can open a Bookmark, providing they have access to the same Resources used in it. | * All Named Users can open a Bookmark, providing they have access to the same Resources used in it. | ||
- | * Anyone else can open a Bookmark that is made public, providing the Organisation has enough | + | * Anyone else can open a Bookmark that is made public, providing the Organisation has enough Guest Users left. |
+ | ==== Coordinates ==== | ||
- | ===== Coordinate | + | A Coordinate |
- | A '' | + | By default, all data returned by the SDK is expressed |
- | ===== CRS ===== | + | ==== Coordinate Reference System |
- | A '' | + | A CRS or Coordinate Reference System is a system |
- | Spatial objects provided to the '' | + | Spatial objects provided to the Viewer must always be accompanied by a CRS code. \\ |
- | Spatial objects that are provided | + | Spatial objects that are returned |
- | By default, all data returned by the SDK is expressed in WGS/ | + | ==== Coverage ==== |
- | The default CRS is EPSG:4326 (2D WGS/84). | + | Coverage |
+ | ==== 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-Views are provided by the SDK as '' | Field-Of-Views are provided by the SDK as '' | ||
- | ===== Footprint ===== | ||
- | A '' | + | ==== Footprint ==== |
+ | |||
+ | 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 |
+ | |||
+ | Global state (focus, mouse hover). | ||
+ | |||
+ | ==== Login ==== | ||
- | 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. | + | When you launch the SDK, you need to log in to a service that will provide the data. The SDK supports both cloud-based and on-premise content. |
[[https:// | [[https:// | ||
- | - Login to 3D Mapping Cloud as [[https:// | + | - Login to 3D Mapping Cloud as [[https:// |
- | - Login to 3DM Publisher : Requires Publisher Url, User and Password. Then choose a Publication. | + | - 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:// | + | - Use a token to get access to a 3D Mapping Cloud Publication as [[https:// |
- | It is possible to Preset | + | It is possible to pre-set |
- | Preset | + | * The preset |
+ | * 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 to preset a 3DM Cloud Named User Login. | + | Note: For security reasons, we do not allow the SDK Developer to preset a 3DM Cloud Named User Login. |
==== MapObjects ===== | ==== MapObjects ===== | ||
- | A '' | + | Visualisation |
- | * Spatial information (point, | + | |
- | * Legend information (line color, etc...) | + | |
- | + | ||
- | MapObjects are used throughout the SDK to convey what needs to be rendered on the '' | + | |
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 70: | 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 '' | ||
- | ===== Signal ===== | ||
- | A '' | + | ==== Resource ==== |
- | Some signals also provide | + | 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. |
- | By convention, signal names are camel-cased and always start with " | + | ==== Signal ==== |
- | ===== Start-Up Options ====== | + | A Signal can be best described as an event emitter. |
- | A '' | + | Signals start with "on" by convention (for example " |
- | One example of such an option is the " | + | ==== Start-Up Options ===== |
- | ===== User ===== | + | A Start-Up Option is a named value that can be provided on viewer startup. |
- | There are 3 types of users, all automatically handled by the SDK (see '' | + | 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 ==== | ||
+ | |||
+ | 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 ==== | ||
+ | |||
+ | The Viewer is the framework in which a publication is made and resources are represented. | ||
+ | |||
+ | ==== Viewer3DM | ||
- | A '' | + | The central Viewer component |
- | ===== 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:11