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_plugin_qgis [2019/02/25 11:58]
nathalie.moerman@orbitgt.com 		dev:products:3dm_plugin_qgis [2023/01/17 12:43]
jeroen removed
Line 1: Line 1:
 ====== Orbit 3DM Plugin for QGIS ===== ====== Orbit 3DM Plugin for QGIS =====
  
-This pages describes the plugin for QGIS from which a user can connect and interact with the Orbit 3D Mapping Viewer. \\+This page describes the Orbit 3D Mapping Plugin for QGIS.
  
-Reference documentation: +return to [[dev:products:3dm_plugins|]] 
-  * [[dev:products:3dm_viewer_cloud|3D Mapping Cloud Viewer]] +===== Download and Install =====
-  * [[dev:products:3dm_viewer_publisher|3DM Publisher HTML5 Viewer]]+
  
-====Requirements====+=== Requirements ===  
 +See [[211:technology:platforms:specs_webclient|]].
  
-**QGIS**\\ +=== Download and unzip  ===
-QGIS version 3.4 or later is required.+
  
-**Browser**\\ +Download and unzip the Orbit Plugin installation package from the Orbit website, [[https://orbitgt.com/3dm-plugin/]].
-See: [[dev:technology:platforms:specs_webclient|]]+
  
-====Download and Installation====+=== Install Orbit Plugin ===
  
-**Download and install QGIS**\\ +  * Start QGIS 
-See: [[https://qgis.org/en/site/forusers/download.html|Download QGIS]]+  * Open QGIS Plugin Manager. 
 +  * Choose "Install from ZIP", select the downloaded orbit3dmapping.zip file and click the "Install Plugin" button. 
 +  * Accept the "Security Warning: Continue?" pop-up confirmation. 
 +  * The "Plugin installed successfully" pop-up confirmation appears, the Orbit toolbar is added.
  
-**Download Orbit 3D Mapping Plugin for QGIS**\\ +=== Install Phyton WebSockets === 
-Download the .zip package on the Orbit website: [[https://orbitgt.com/3dm-plugin/|Orbit 3DM Plugins]]+
  
-**Install plugin in QGIS**\\+The Orbit Plugin requires the installation of Python's WebSockets package. 
  
-  * Open Plugin Manager in QGIS. +On first use of the Orbit Plugin, accept the "The 3D Mapping plugin needs to install some additional software" pop-up confirmation. \\ 
-  * Choose "Install from ZIP" and select the .zip file and press the "Install Plugin" button. +If QGIS is installed on "C:\Program Files\" additional steps might be required to install the Phyton's WebSockets package. \\ 
-  * Press yes when the "Security Warning: Continue?" pop-up appears. +Complete the actions as suggested in the pop-up notification and run the "Install_plugins" batch file as administrator.
-  * If everything went well, the "Plugin installed successfully" pop-up appears and a new toolbar is added.+
  
-====Orbit 3D Mapping Toolbar in QGIS ====+=== Offline Plugin installation ===
  
-{{:dev:products:qgis_plugin_toolbar.png|}}+This plugin can be installed for offline use, see [[dev:viewer:plugin:local_viewer_sdk|]].
  
-**Open the 3D Mapping Viewer**\\ +===== Save Measurements =====
-When launching the Orbit 3D Mapping Viewer from the toolbar in QGIS, a new tab will be opened in the standard browser of the user. If there is no window active yet in that browser, than a new window will be launched. \\+
  
-At first run the plugin tries to install the python "websockets" package. Press "OK" when the pop-up message "The 3D Mapping plugin needs to install some additional software" appears. +To save the measurement results from the 3DM Viewer into the host layer, the following internal names of the measurement properties should be used as attributes of the host layer:\\ 
 +  * PROPERTY_X = "x" 
 +  * PROPERTY_Y = "y" 
 +  * PROPERTY_Z = "z" 
 +  * PROPERTY_DISTANCE_Z = "distanceZ" 
 +  * PROPERTY_DISTANCE_XY = "distanceXY" 
 +  * PROPERTY_DISTANCE_XYZ = "distanceXYZ" 
 +  * PROPERTY_LENGTH_Z = "lengthZ" 
 +  * PROPERTY_LENGTH_XY = "lengthXY" 
 +  * PROPERTY_LENGTH_XYZ = "lengthXYZ" 
 +  * PROPERTY_HEIGHT = "height" 
 +  * PROPERTY_AREA_XY = "areaXY" 
 +  * PROPERTY_AREA_XYZ = "areaXYZ" 
 +  * PROPERTY_SLOPE = "slope" 
 +  * PROPERTY_SLANT = "slant" 
 +  * PROPERTY_CLEARANCE = "clearance" 
 +  * PROPERTY_SPAN = "span" 
 +  * PROPERTY_WIDTH = "width" 
 +  * PROPERTY_RADIUS = "radius" 
 +  * PROPERTY_VOLUME = "volume" 
 +  * PROPERTY_BASELINE1 = "baseline1" 
 +  * PROPERTY_BASELINE2 = "baseline2" 
 +  * PROPERTY_ERROR_XYZ = "errorXYZ" 
 +  * PROPERTY_ERROR_XY = "errorXY" 
 +  * PROPERTY_ERROR_Z = "errorZ" 
 +  * PROPERTY_HEADING = "heading" 
 +  * PROPERTY_ANGLE = "angle"\\
  
-If QGIS was installed to "C:\Program Files" an additional step needs to be taken: run a batch file as administrator. __SPECIFY BATCH FILE__ 
  
-On opening a publication or viewer, the Footprints of the resources and Field of Views are made visible in QGIS and are updated when they are changed in the 3D Mapping Viewer. 
- 
-**Show or hide the footprints**\\ 
-Option to disable the visibility of Orbit layers (Footprints, Field of Views and Measurements) in QGIS. The layers can also be made invisible separately in the QGIS workspace by unchecking the box next to the layer name in the layer list. 
- 
-**Pick a location in the map canvas to open the viewer**\\ 
-Pick a location on the map canvas in QGIS to refocus all opened Views and the Reference View in the Orbit 3D Mapping Viewer to the chosen location. 
- 
-**Add the selected objects as overlays to the viewer**\\ 
- 
- 
-**Add the measurements to the active layer**\\ 
- 
-**Open the help pages**\\