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/05/12 16:45]
jeroen [Introduction] 		dev:viewer:sdk:concepts [2022/09/28 13:10] (current)
pieter
Line 1: Line 1:
-====== Technical Concepts ======+====== Glossary Technical Concepts ======
  
-This page describes some basic concepts of the 3DM Viewer and 3DM Viewer SDK. +This page is a glossary describing some basic concepts of the 3DM Viewer and 3DM Viewer SDK.
- +
-===== Introduction ====== +
- +
-==== Cost ==== +
- +
-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, augmenting, enriching and integrating datasets at both sides. \\ +
- +
-===== Glossary =====+
  
 ==== Bookmark ==== ==== Bookmark ====
Line 23: 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:4326  To change the CRS of data returned by the SDK, please provide the ''Constants.STARTUP_CRS'' option at Viewer startup.
- +
-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.+
  
 ==== Coordinate Reference System ==== ==== Coordinate Reference System ====
Line 38: Line 24:
  
 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. 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.
 +
 +==== 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. 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 or an Envelope. \\
  
 Footprints are provided by the SDK as ''MapObjects''.  Footprints are provided by the SDK as ''MapObjects''. 
Line 70: 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,line,area) +
-  * Legend information (line color, etc...)+
  
-Currently, there are four types of MapObjects that can be rendered in their own layer. +To represent objects to be rendered, we decided on introducing a self-describing type called a ''MapObject''.  
-  * 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.  Let us worry about presentation. 
 + 
 +==== Measurement ====
  
 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.   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).
 +
 +==== 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 99: 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 ''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.
  
 ==== Resource ==== ==== Resource ====
Line 106: Line 108:
 ==== 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 CamelCase and always start with "on".+
  
 ==== Start-Up Options ===== ==== Start-Up Options =====
Line 117: Line 117:
  
 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 ====
 +
 +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.
  
 ==== User ==== ==== User ====
Line 132: 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 ''Viewer3DM''.
  
 ==== Workspace ==== ==== Workspace ====
 
Last modified:: 2020/05/12 16:45