====== Glossary of terms used ====== This page explains terminology used throughout the 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''. 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. * Anyone else can open a Bookmark that is made public, providing the Organisation has enough ''Guest Users'' left. ===== Coordinate ===== A ''Coordinate'' represents an exact geographical location in a specific ''CRS''. ===== CRS ===== A ''CRS'' is the EPSG Code of a Coordinate Reference System that is used to interpret ''Coordinates'', see [[203:technology:core:crs|]]. 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. ===== Field Of View ===== 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''. ===== 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''. \\ Footprints are provided by the SDK as ''MapObjects''. ===== MapObject ===== A ''MapObject'' is an object that defines everything needed to render it : * 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. ===== 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. [[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.\\ 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. ===== 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. 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, ...). ===== Publication ===== 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. ===== 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. ===== 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. ===== 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''. Some signals also provide a ''payload'' when they dispatch an event. By convention, signal names are camel-cased and always start with "on". ===== 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. 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). ===== User ===== There are 3 types of users, all automatically handled by the SDK (see ''Login'') * [[https://3dmapping.cloud/about-named-users-and-teams/|3D Mapping Cloud - Named Users]] * [[https://3dmapping.cloud/about-guest-users/|3D Mapping Cloud - Guest Users]] * 3DM Publisher users ===== View ===== A ''View'' is a single interactive component of the ''Viewer'' ''Workspace'' that visualizes the visible ''Resources'', in some way or form. ===== 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. 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.