Knowledge Base
Recent Changes

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
dev:viewer:sdk:concepts [2020/03/31 13:13]
nathalie 		dev:viewer:sdk:concepts [2022/09/28 13:10] (current)
pieter
Line 1: Line 1:
-====== Concepts and glossary ======+====== Glossary Technical 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 7: Line 9:
 Bookmarks can also be opened by anyone with the Bookmark's URL : Bookmarks can also be opened by anyone with the Bookmark's URL :
   * 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 ''Guest Users'' left.+  * Anyone else can open a Bookmark that is made public, providing the Organisation has enough Guest Users left.
  
 +==== Coordinates ====
  
-===== Coordinate =====+A Coordinate represents an exact geographical location in a specific CRS.
  
-A ''Coordinate'' represents an exact geographical location in a specific ''CRS''.+By default, all data returned by the SDK is expressed in WGS84, EPSG:4326  To change the CRS of data returned by the SDK, please provide the ''Constants.STARTUP_CRS'' option at Viewer startup.
  
-===== Coverage =====+==== Coordinate Reference System ====
  
-===== CRS ===== +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:technology:core:crs|]]. \\
- +
-A ''CRS'' is the EPSG Code of a Coordinate Reference System that is used to interpret ''Coordinates'', see [[dev:technology:core:crs|]].+
    
-Spatial objects provided to the ''Viewer'' must always be accompanied by a CRS code. +Spatial objects provided to the Viewer must always be accompanied by a CRS code. \\
- +
-Spatial objects that are provided by the SDK are expressed in WGS84 (EPSG code "4326") by default.  You can change this by passing a ''Startup Option'' to the ''Viewer'' constructor, instructing it to use a different CRS.+
  
-By default, all data returned by the SDK is expressed in WGS/84.  To change the CRS of data returned by the SDK, please provide the ''Constants.STARTUP_CRS'' option at Viewer startup.+Spatial objects that are returned by the SDK are expressed in WGS84 (EPSG code 4326) by default.  You can change this by passing a Startup Option to the Viewer constructor, instructing it to use a different CRS.
  
-The default CRS is EPSG:4326 (2D WGS/84).+==== 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 ''MapObjects''.
  
-===== Footprint ===== +==== Footprint ==== 
  
-A ''Footprint'' is the representation of a visible ''Resource'' on the ''Reference Map''. Footprints are useful to indicate data availability. Footprint can be ''Photo Position'', ''Simplified Coverage'' or ''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 or an Envelope. \\
  
 Footprints are provided by the SDK as ''MapObjects''.  Footprints are provided by the SDK as ''MapObjects''. 
  
-===== 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://3dmapping.cloud/about-sdk-login/|There are 3 ways to login]] : +
-  - Login to 3D Mapping Cloud as [[https://3dmapping.cloud/about-named-users-and-teams/|Named User]] : Requires User and Password. +
-  - 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://3dmapping.cloud/about-guest-users/|Guest User]] : Requires a Publication or Bookmark token.+
  
-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 to preset a 3DM Cloud Named User Login.+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://3dmapping.cloud/about-sdk-login/|There are 3 ways to login]] : 
 +  - Login to 3D Mapping Cloud as [[https://3dmapping.cloud/about-named-users-and-teams/|Named User]]: Requires User and Password. 
 +  - 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://3dmapping.cloud/about-guest-users/|Guest User]]: Requires a Publication or Bookmark token. 
 + 
 +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 ''MapObject'' is an object that defines everything needed to render it :  +==== MapObjects =====
-  * Spatial information (point,line,area) +
-  * Legend information (line color, etc...)+
  
-MapObjects are used throughout the SDK to convey what needs to be rendered on the ''Reference Map''. This can be ''Footprint'' data, ''Field-of-view'' data, measurements or other.+Visualisation of Data
  
 To represent objects to be rendered, we decided on introducing a self-describing type called a ''MapObject''.  To represent objects to be rendered, we decided on introducing a self-describing type called a ''MapObject''. 
Line 73: Line 74:
 By using MapObjects, we move the complexity of representing Viewer data out of your code and into the Viewer SDK itself.  Let us worry about presentation. By using MapObjects, we move the complexity of representing Viewer data out of your code and into the Viewer SDK itself.  Let us worry about presentation.
  
-===== Measurement =====+==== Measurement ====
  
-A ''Measurement'' can be anything you measure.  When creating a Measurement, you are always doing so in a specific mode.  The Measurement mode defines what you are measuring.  +A Measurement can be a point, line or area you measure.  When creating a Measurement, you are always doing so in a specific mode.  The Measurement mode defines what you are measuring.  
  
-When making a Measurement, you are making registrations.  Depending on the mode, the required number of measurements can be fixed, or open-ended.  An open-ended measurement mode requires the user to close the Measurement manually (usually by double clicking on the last measurement).+When making a Measurement, you are making registrations.  Depending on the mode, the required number of measurements can be fixed, or open-ended.  An open-ended measurement mode requires the user to close the Measurement manually (usually by double-clicking on the last 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'' can be created by a Named User to share a ''Workspace'' in a formal way.  Publications add detailed permissions and an extra layer of Viewer configuration to the Workspace.+==== Publication ====
  
-===== Promise =====+A Publication is a representation of Resources in the Viewer. A publication is the end product of the [[dev:products:3dm_cloud|3D Mapping Cloud]] or [[dev:products:3dm_publisher|3DM Publisher]].
  
-A ''Promise'' is an object instance that is a placeholder for a value that is not yet available.  When the value is not yet available, a Promise is  said to be 'pending'.  When the value is available, the Promise is said to be 'resolved'.  If a problem occurs the promise is said to be 'failed'.+==== Promise ==== 
 + 
 +A Promise is an object instance that is a placeholder for a value that is not yet available.  When the value is not yet available, a Promise is  said to be 'pending'.  When the value is available, the Promise is said to be 'resolved'.  If a problem occurs the promise is said to be 'failed'.
  
 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 ''Reference Map'' is the map on which you can get your bearings.  It shows you where ''Resources'' and ''Views'' are situated.  +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 ''Viewer'' has an built-in reference map.+
  
 +The ''Reference Map'' is the map on which you can get your bearings.  It shows you where ''Resources'' and ''Views'' are situated.  \\
 +The ''Viewer'' has an built-in reference map. \\
 The ''Orbit 3dMapping Viewer SDK'' was created specifically to to enable any third-party viewer to be used as a reference map. The ''Orbit 3dMapping Viewer SDK'' was created specifically to to enable any third-party viewer to be used as a reference map.
  
 +==== 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 ''Signal'' can be best described as an event emitter.  It manages a list of interested parties, and informs them if an event occurs.  Its name usually reflects the event that is dispatched, for example : ''onReady''.+A Signal can be best described as an event emitter.  Signals are provided throughout the SDK to cover different use-cases where your integration will want to be notified of certain events.
  
-Some signals also provide a ''payload'' when they dispatch an event.+Signals start with "on" by convention (for example "onFootprintsChanged").
  
-By convention, signal names are camel-cased and always start with "on".+==== Start-Up Options =====
  
-===== Start-Up Options ======+A Start-Up Option is a named value that can be provided on viewer startup.  It can be used to affect some inner workings of the Viewer.
  
-A ''Start-Up Option'' is a named value that can be provided on viewer startup.  It can be used to affect some inner workings of the Viewer.+One example of such an option is the "CRS" option.  This setting can be used to provide the CRS to be used by the SDK when returning spatial data.  The full list of options can be found in the [[https://orbitgt.com/kb/developer/sdk_reference_docs|reference documentation]] (startup options have a STARTUP_ prefix).
  
-One example of such an option is the "crs" option.  This setting can be used to provide the ''CRS'' to be used by the SDK when returning spatial data.  The full list of options can be found in the [[https://orbitgt.com/kb/developer/sdk_reference_docs|reference documentation]] (startup options have a ''STARTUP_'' prefix).+==== Tilt Angle ====
  
-===== User =====+The viewing direction of a view in the vertical plane parallel to the viewing direction.  Zero degrees indicates the view is looking at the horizon and 90 degrees indicates the view is looking up.  Tilt is similar to pitch in aviation.
  
-There are 3 types of users, all automatically handled by the SDK (see ''Login'') +==== User ==== 
 + 
 +There are 3 types of users, all automatically handled by the SDK (see Log in) 
   * [[https://3dmapping.cloud/about-named-users-and-teams/|3D Mapping Cloud - Named Users]]    * [[https://3dmapping.cloud/about-named-users-and-teams/|3D Mapping Cloud - Named Users]] 
   * [[https://3dmapping.cloud/about-guest-users/|3D Mapping Cloud - Guest Users]]    * [[https://3dmapping.cloud/about-guest-users/|3D Mapping Cloud - Guest Users]] 
   * 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 ''View'' is a single interactive component of the ''Viewer'' ''Workspace'' that visualizes the visible ''Resources'', in some way or form. +The Viewer is the framework in which a publication is made and resources are represented. 
  
-===== Viewer =====+==== Viewer3DM ====
  
 +The central Viewer component is named ''Viewer3DM''.
  
-===== Workspace =====+==== Workspace ====
  
-A ''Workspace'' defines a list of ''Resources'' and how they are presented by the ''Viewer''.  A Workspace uses one or more ''View'' components to display the Resources.  A Workspace also includes a range of settings and parameters that help build up the full state of the Viewer.+A Workspace defines a list of Resources and how they are presented by the Viewer.  A Workspace uses one or more View components to display the Resources.  A Workspace also includes a range of settings and parameters that help build up the full state of the Viewer.
  
 Publications and Bookmarks use a Workspace to store the Viewer state.  Bookmarks let you share a Workspace informally.  Publications add permissions and an extra layer of configuration to create a more formal presentation of the data and viewing experience. Publications and Bookmarks use a Workspace to store the Viewer state.  Bookmarks let you share a Workspace informally.  Publications add permissions and an extra layer of configuration to create a more formal presentation of the data and viewing experience.
 
Last modified:: 2020/03/31 13:13