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:products:3dm_plugins [2020/10/15 08:34]
paulien [Offline Use] 		dev:products:3dm_plugins [2024/03/28 07:42] (current)
pieter [Downloads]
Line 1: Line 1:
 ====== Orbit 3DM Plugins ===== ====== Orbit 3DM Plugins =====
  
-===== Installation =====+Reference documentation of Orbit 3DM Plugins for [[dev:products:3dm_publisher|Orbit 3DM Publisher]] and [[dev:products:3dm_cloud|Orbit 3DM Cloud]].
  
-Orbit offers a proof of concept plugins that are created using the free [[dev:products:viewer_sdk|3DM Viewer SDK]]. +===== Concept =====
  
 +Orbit 3DM Plugins can be used to visualize reality data from Orbit 3DM Publisher or Cloud in a 3rd party application. The 3DM Viewer can interact with the application to navigate, synchronize, save measurements, overlay objects...
  
-The plugins embed the Orbit 3DM Viewer. Generic requirements are documented here:  +===== Downloads =====
-  * [[dev:technology:platforms:specs_webclient|]].+
  
-Specific requirements related to the host application can be reviewed here: +  * {{:technology:plugins:orbit-3dm-plugin-microstation-2170.zip|orbit-3dm-plugin-microstation}} 
-  * [[dev:products:3dm_plugin_qgis|]] +  * {{:technology:plugins:orbit-3dm-plugin-esri-arcmap-2050.zip|orbit-3dm-plugin-esri-arcmap}} 
-  * [[dev:products:3dm_plugin_arcgis|]] +  * {{:technology:plugins:orbit-3dm-plugin-esri-arcgispro-2050.zip|orbit-3dm-plugin-esri-arcgispro 2.X}} 
-  * [[dev:products:3dm_plugin_arcgispro|]] +  * {{:technology:plugins:plugin_3dm_esri_arcpro3.zip|orbit-3dm-plugin-esri-arcgispro 3.X}} 
-  * [[dev:products:3dm_plugin_autocad|]] +  * {{:technology:plugins:orbit-3dm-plugin-esri-webappbuilder-widget-2401-code.zip|orbit-3dm-plugin-esri-webappbuilder-widget}}<sup>UPDATED</sup> 
-  * Microstation +  * {{:technology:plugins:orbit-3dm-plugin-arcgis-experiencebuilder-widget-2401-code.zip|orbit-3dm-plugin-arcgis-experiencebuilder-widget}} <sup>NEW</sup> 
-  * ESRI WebAppBuilder+  * {{:technology:plugins:orbit-3dm-plugin-autodesk-autocadmap-19100.zip|orbit-3dm-plugin-autodesk-autocadmap}} 
 +  * {{:technology:plugins:orbit-3dm-plugin-qgis-2401.zip|orbit-3dm-plugin-qgis}}<sup>UPDATED</sup>
  
 +===== Plugin-specific documentation =====
  
-===== Orbit 3D Mapping Toolbar ===== +  * [[dev:products:plugin:3dm_plugin_microstation|]] 
-All plugins have their specific installation, related to their host application. But the Orbit 3D Mapping Toolbar is the same for all the host applications. Underneath the different tools are described. \\+  * Orbit 3DM Viewer for Bentley iModel.JS and iTwin applications 
 +  * [[dev:products:plugin:3dm_plugin_qgis|]] 
 +  * [[dev:products:plugin:3dm_plugin_arcgisonline|]] 
 +  * [[dev:products:plugin:3dm_plugin_arcgis|]] 
 +  * [[dev:products:plugin:3dm_plugin_arcgispro|]] 
 +  * [[dev:products:plugin:3dm_plugin_autocad|]] 
 + 
 +=== PLugins provided by Orbit Partners === 
 + 
 +  * [[dev:products:plugin:3dm_plugin_smallworld|]] 
 +  * Orbit 3DM Plugin for iBMaximo 
 + 
 +===== Related documentation ===== 
 + 
 +  * [[dev:products:3dm_viewer|]] 
 +  * [[dev:products:3dm_viewer_sdk|]] ((Including plugin source code)) 
 +  * [[dev:technology:platforms:specs_webclient|]] 
 +  * [[dev:viewer:other:local_viewer_sdk|]] 
 + 
 +===== Orbit 3DM Plugin Toolbar ===== 
 + 
 +All plugins have their specific installation, related to their host application. But the Orbit 3D Mapping Plugin Toolbar is the same for all the host applications. Underneath the different tools are described. \\
 {{:dev:products:plugin_qgis_menu.png?nolink|}} \\ {{:dev:products:plugin_qgis_menu.png?nolink|}} \\
 \\ \\
 **Open the 3D Mapping Viewer**\\ **Open the 3D Mapping Viewer**\\
-When launching the Orbit 3D Mapping Viewer from the toolbar, a new tab will be opened in the default browser of the user. If there is no window active yet in that browser, then a new window will be launched. The new window shows the [[203:products:3dm_plugins|3D Mapping Viewer Welcome page]].\\ +When launching the Orbit 3D Mapping Viewer from the toolbar, a new tab will be opened in the default browser of the user. If there is no window active yet in that browser, then a new window will be launched. The new window shows the [[dev:products:3dm_plugins|3D Mapping Viewer Welcome page]].\\ 
  
-On opening a publication or viewer, the Footprints of the opened [[203:viewer:sidebars:resources|resources]] and Field of Views are made visible in the host application and are updated when they are changed in the 3D Mapping Viewer.+On opening a publication or viewer, the Footprints of the opened [[dev:viewer:sidebars:resources|resources]] and Field of Views are made visible in the host application and are updated when they are changed in the 3D Mapping Viewer.
  
 **Show or hide the footprints**\\ **Show or hide the footprints**\\
-Option to disable the visibility of Orbit layers (Footprints, Field of Views and Measurements) in the host application. \\+Option to disable the visibility of Orbit layers (Footprints, Field of Views, and Measurements) in the host application. \\
  
 **Pick a location in the map canvas to open the viewer**\\ **Pick a location in the map canvas to open the viewer**\\
Line 34: Line 57:
  
 **Add the selected objects as overlays to the viewer**\\ **Add the selected objects as overlays to the viewer**\\
-This option gives the possibility to visualize features from an external layer on the 3D Mapping Viewer. The features are visualized in the 3D Mapping Viewer using standard formatting. And a new resource is added to the [[203:viewer:sidebars:resources|]]. \\+This option gives the possibility to visualize features from an external layer on the 3D Mapping Viewer. The features are visualized in the 3D Mapping Viewer using standard formatting. And a new resource is added to the [[dev:viewer:sidebars:resources|]]. \\
  
 Steps to be followed: Steps to be followed:
Line 51: Line 74:
     * ArcGIS Pro: Add a layer to ArcGIS Pro. Make sure the layer is selected as the active layer.     * ArcGIS Pro: Add a layer to ArcGIS Pro. Make sure the layer is selected as the active layer.
   * Execute a measurement in the Orbit 3D Mapping Viewer. While measuring, the measurement object is visualized in the host as part of the active layer.    * Execute a measurement in the Orbit 3D Mapping Viewer. While measuring, the measurement object is visualized in the host as part of the active layer. 
-  * Click the button in Plugin to add the measurement object to the active layer in the host. Note that this is only possible if the layer type (Point, Line, Polygon) is the same as the measurement object.+  * Click the button in the Plugin to add the measurement object to the active layer in the host. Note that this is only possible if the layer type (Point, Line, Polygon) is the same as the measurement object.
  
-**Open the help pages**\\ +=== Open the help pages ===
-Orbit Knowledge Base is opened. \\+
  
-===== Plugin Welcome Page  =====+Orbit Knowledge Base is opened.
  
-All plugins have their specifics, related to their host application. But launching the Viewer from the host application is the same for all cases. At the start-up, a new tab in the standard browser is opened. If there is no browser opened yet on the computer than a new browser window will be launched.\\+===== 3DM Cloud or 3DM Publisher Login ===== 
 + 
 +All plugins have their specifics, related to their host application. But launching the Viewer from the host application is the same for all cases. At the start-up, a new tab in the standard browser is opened. If there is no browser opened yet on the computer then a new browser window will be launched.\\
  
 The welcome page lets the user choose between three options: The welcome page lets the user choose between three options:
-  * Sign in to [[dev:products:3dm_cloud|3D Mapping Cloud]]: After sign-in, the [[dev:products:3dm_viewer_cloud|3D Mapping Cloud Viewer]] from this user's account is opened.\\+  * Sign in to [[dev:products:3dm_cloud|3D Mapping Cloud]]: After sign-in, the [[dev:products:3dm_viewer|]] from this user's account is opened.\\
   * Sign in to [[dev:products:3dm_publisher|3DM Publisher]]: First, log in to a server location with URL and login credentials, then choose a publication from the drop-down menu.   * Sign in to [[dev:products:3dm_publisher|3DM Publisher]]: First, log in to a server location with URL and login credentials, then choose a publication from the drop-down menu.
   * I have a token or URL: Open a publication from the 3D Mapping Cloud using its token or URL. The publication is only accessible if the publication is shared with guest users and the number of guest users is not yet succeeded.    * I have a token or URL: Open a publication from the 3D Mapping Cloud using its token or URL. The publication is only accessible if the publication is shared with guest users and the number of guest users is not yet succeeded. 
Line 69: Line 93:
 In every option, you can toggle on the 'remember me' checkbox to automatically log in with the filled-in credentials. After restarting the host application, the new setting will be used.  In every option, you can toggle on the 'remember me' checkbox to automatically log in with the filled-in credentials. After restarting the host application, the new setting will be used. 
 {{:dev:products:3dm_plugins_welcomepage.png?nolink900|}} {{:dev:products:3dm_plugins_welcomepage.png?nolink900|}}
-===== Offline Use ===== 
- 
-The plugin can be used offline and for a publication from a 3DM Publisher that is running insecure (on http). A configuration file has to be created to give up the publisher URL.  
- 
-Underneath is the configuration file for every available offline plugin: 
-  * QGIS: {{ :dev:products:plugin_qgis.zip |}} 
-  * ArcGIS: {{ :dev:products:plugin_arcmap.zip |}} 
-  * ArcGIS Pro: {{ :dev:products:plugin_arcpro.zip |}} 
-This ini-file has to be copied to the folder ''C:\plugins'' on the machine where the host application is installed. The localhost and port in the publisherURL can be modified to the specs of the installed 3DM Publisher.  
- 
-An extra line ''default.attribute.value.MyAttribute=MyValue'' can be added to this configuration file to give up a default value for an attribute. In the example underneath, the default value for the attribute 'type' will be 'cable' when saving a measurement from the 3D Mapping Viewer to a layer.  
  
-<code> 
-publisherURL=http://localhost:1111/viewer_sdk/?mode=websocket&protocol=ws&hostname=localhost&port=7200&endpoint=/endpoint 
-default.attribute.value.type=cable 
-</code> 
  
 
Last modified:: 2020/10/15 08:34