.. raw:: html

    <style> .red {color:red} </style>

.. role:: red

==============
Project Viewer
==============

We have seen how to :doc:`create a project <project>` and :ref:`add data layers <layer_add>` to it. Before performing an analysis based on these data layers, we need to understand how to organize and explore the data in the Project Viewer.


Project Viewer Sections
=======================

The interface of Pathfinder consists of four major components:

  * The left panel (1) lists the **layers** added to the project, grouped by **category**.

  * The top menu (2) includes commands to modify the **project** and its **scenarios**, calculate and export the analysis **results**, and access the application **configuration**.

  * The right panel (3) has specific sections to manage scenarios and their results.

  * The central view (4) offers an interactive **2D map or 3D view** of the data and the results. 

.. image:: ./images/viewerStructure.jpg
    :align: center
    :width: 90%

Side panels (sections 1 and 3) can be hidden and reopened by clicking on their pull handles, and their width changed by dragging sideways from the handle:

.. image:: ./images/resize_panel.jpg
  :align: center
  :width: 60%

.. _organize_data:


Organize Data
=============

Data layers are listed in the left panel, grouped by their **category**. The category is assigned when a :ref:`layer is added <layer_add>` to the project, but it can be changed later.

.. image:: ./images/layersPanel.jpg
    :align: center
    :width: 40%

The role of categories is to group layers which share a common theme (for instance, existing infrastructures, physical environment, land property, etc.) so the user can adjust their weight (importance) in the analysis scenario.

.. note::
   :doc:`Users <userFunctions>` who are not admin/staff can't create, modify or delete categories or their layer list. Ask your administrator to do it for you.


Create New Category
-------------------

A new category can be created from the *Project/New Category* menu option and also from the corresponding button in the Layers panel header.

.. image:: ./images/newCategory.jpg
    :align: center
    :width: 50%

The category name is assigned in the following dialog:

.. image:: ./images/newCategoryDlb.jpg
    :align: center
    :width: 50%


Change Layer Category
---------------------

Layers can be moved to a different category by clicking on them and dragging them to a different group.

.. image:: ./images/layerDrag.jpg
    :align: center
    :width: 40%

The category of a layer can also be changed in the *Layer Preprocessing* dialog, which opens from the Project menu or from the button in the Layers panel header.

.. image:: ./images/layerPreprocBtn.jpg
    :align: center
    :width: 50%


Change Names
------------

To change the name of a category or layer, double-click on its name, type the modified name and *hit Enter*, or click outside the Layers panel to cancel the change.

.. image:: ./images/layerChangeName.jpg
    :align: center
    :width: 30%


Delete a Layer
--------------

A layer can be removed by using the *Delete* button in its side panel. First, open the side panel to the right of the layer item, and then click on the Delete button:

.. image:: ./images/layerDelete.jpg
    :align: center
    :width: 60%

A dialog will prompt the user to confirm the operation:

.. image:: ./images/layerDeleteConfirm.jpg
    :align: center
    :width: 60%

.. note::
   *If a layer is removed from the project, it can be recreated from the base data without the need to upload it again.*


Delete a Category
-----------------

Like the layers, a category can be removed from the project by using the *Delete* button in its side panel.

.. image:: ./images/categoryDelete.jpg
    :align: center
    :width: 60%

A dialog will prompt the user to confirm the operation:

.. image:: ./images/categoryDeleteConfirm.jpg
    :align: center
    :width: 60%

.. note::
   *If a category is removed, all the layers it contains will also be removed from the project.*


Explore Data
============

The main view of Pathfinder is used to explore data added to the project and the results of the analysis processes.

In order to display a layer in the view, it must be made visible.


Layer Visibility
----------------

A layer can be displayed in two ways:

* **Original layer**: Displays the original vector features of the layer without buffering. Use the first visibility button:

  .. image:: ./images/layerVisOriginal.jpg
      :align: center
      :width: 50%

  This is the only visibility option available for *raster layers*:

  .. image:: ./images/layerVisRaster.jpg
      :align: center
      :width: 50%

|

* **Buffered layer**: Available for vector data. It displays the features with buffering, showing one or multiple rings depending on the :ref:`layer configuration <layer_settings>`. For multiple rings, different transparency values are applied. Use the second visibility button to switch this mode on:

  .. image:: ./images/layerVisBuffer.jpg
      :align: center
      :width: 50%

|

The following image shows the difference between the original (left) and the buffered displays (right):

.. image:: ./images/originalVersusBuffered.jpg
    :align: center
    :width: 90%

The visibility of *all buffered layers in a category* can be changed at once with the button located in the category header, identical to the layers'.

.. image:: ./images/showAllLayers.jpg
      :align: center
      :width: 50%

.. note::
    *Since raster layers do not have a buffered version, the toggle to display all buffered layers does not affect them.*


Layer Color
-----------

To better understand the information provided by different layers in the view, a different color can be assigned to each layer. 

Click on the colored square next to the layer name to open the color picker.

.. image:: ./images/layerColor.jpg
    :align: center
    :width: 25%

.. image:: ./images/colorPicker.jpg
    :align: center
    :width: 30%

You can also control the *transparency* of the color by using the transparency slider in the color picker typing an opacity value in the A field (0 means fully transparent, 100 completely opaque). Transparency is only applied to the Map view.

When applied to a **raster layer**, the color is displayed lighter for smaller values in the raster and darker for larger values, as in this slope example:

.. image:: ./images/rasterColor.jpg
    :align: center
    :width: 60%


Search Layers
-------------

If your project has many layers, it may be difficult to find quickly the one you want to edit. To quickly find layers by name, use the Layer Search field at the bottom of the Layers panel. Type one or more characters, and only the layers whose name includes the typed text will be shown in the panel:

.. image:: ./images/layerSearch.jpg
    :align: center
    :width: 40%

.. _map_view:

Map View
========

Data and results are displayed in the central view. By default, this shows an interactive 2D Map, but most its options and tools are common to the 3D View. These tools can be found in the View menu and also as floating buttons on either view.

.. image:: ./images/mapView.jpg
    :align: center
    :width: 75%

The **View Menu** provides direct access to view options. For the 2D Map, these are:

.. image:: ./images/viewMenu.jpg
    :width: 30%
    :align: center

* **Center View**: zooms the view to the data extent.

* **Switch to 3D View** (or back to 2D): it will use a 3D globe to display the data and results, including a realistic display of the pylons and cables, which can also be interactively moved by the user.

* **Presentation View**: switches to a view mode with limited interaction capabilities, for :ref:`public presentations <presentation_view>`.

* **Base Map**: lets the user choose which map service to use as a background reference image.

* **Show** options, including:

  * *Legend*: toggles on/off the color ramp legend to interpret Resistance Maps and Corridors.

    .. image:: ./images/legend.jpg
      :align: center
      :width: 25%

  |

  * *Full Screen*: toggles on/off the full screen mode (F11 key can also be used).

  * *Pylon*: shows or hides the :ref:`visualization of pylons <pylon_viz>`

Tools
-----

This menu contains tools to operate on both the Map view and the 3D view:

  .. image:: ./images/toolsMenu.jpg
    :width: 30%
    :align: center


  * *Identify Point*: lets the user find out what the resistance values at a certain location on the view. It is described in the :ref:`analysis <identify_tool>` page.

  * *Search Location*: find a place by typing its name. A list of matching places will be offered from which the user can pick one to zoom to:

    .. image:: ./images/searchLocation.jpg
       :align: center
       :width: 50%

    |

  * *Measurement Tools*: opens the measurement toolset on the view. This toolset includes *distance, area and elevation* measurement tools. *Note that the elevation values returned by this tool are Ellipsoidal Height values, not Orthometric Height (above sea level)*.

    .. image:: ./images/measurement.jpg
       :align: center
       :width: 25%

    |

  * *Pylon tools*: it opens the pylon toolset on the view. This toolset includes tools to move and get info about individual pylons. The :ref:`3D version <pylon_tools>` has an additional tool to detect conflicts between cables and terrain.

    To move a path point, activate the Move tool, and click and drag on one of the yellow circles appearing around the points. 

    .. image:: ./images/pylonTools2D.jpg
       :align: center
       :width: 50%

    Right click to finish the editing operation and accept the changes if you want to keep them.


  * *Screenshot*: captures an image of the view and saves it to local disk.

  * *Streetview*: very convenient to check the situation on the ground. :ref:`See below <streetview>`.


Navigation
----------

Use the *left mouse/trackpad button* to click and drag on the 2D Map view, so you can move around.

To zoom in and out, use the *mouse wheel* or drag up and down with *two fingers on the trackpad*.


3D View
=======

By clicking on the *View/3D View* menu option or on the 3D tool button on the 2D Map, the view can switch to a 3D perspective of the project area.

.. image:: ./images/view3D.jpg
   :align: center
   :width: 90%

In this view we have some additional View menu options:

* *Add 3D Assets*: allows users to :ref:`add custom 3D assets <add_3d_assets>` to the view.

* Additional **View/Show** options are:

  * *Buildings*: toggles on/off the display of world buildings.

    .. image:: ./images/buildings.jpg
       :align: center
       :width: 80%

|

  * *Terrain*: toggles on/off the elevation data. *Note that switching off the terrain may lead to some objects "floating" above the zero elevation plane*.

  * *Underground*:  turns on/off the underground mode with a semi-transparent surface and underground navigation.

    .. image:: ./images/underground_3D.jpg
       :align: center
       :width: 80%

|

To check how the *Pylon Tools* work in 3D, see the :ref:`analysis <pylon_tools>` page.


Navigation
----------

Same as in the 2D Map view, use the *left mouse/trackpad button* to **pan**, and **zoom** in and out with the *mouse wheel* or with *two fingers on the trackpad*.

In addition, you can **rotate the view** with the middle mouse button (or pressing the wheel), or by pressing the *Ctrl key* while using the left mouse.

There is also a **compass** in the bottom right corner of the 3D View, which you can use to know the orientation of the 3D view and navigate around.

.. image:: ./images/compass.jpg
   :align: center
   :width: 20%

.. _identify_attrs: 

Identify and edit feature attributes
====================================

Checking the attributes of geographic elements might be important to :ref:`classify the input data into layers <layer_settings>` to assign different resistance values.

To identify the attributes of objects in a specific layer, use the Identify icon in that layer's settings panel:

.. image:: ./images/identifyAttrib.jpg
  :align: center
  :width: 75%

The cursor will change into a blue dot. Click on an object of the selected layer:

.. image:: ./images/identifyCursor.jpg
  :align: center
  :width: 60%

After clicking, if one or more features are found in the selected location, their IDs and attributes will be shown in the Identify dialog:

.. image:: ./images/identifyAttrDlg.jpg
  :align: center
  :width: 60%

The features values can then be **edited** for uploaded and WFS layers, but not for OpenStreetMap layers. Type the value you want and then click *Enter*. When you do so and the change is performed, a green checkbox will appear next to it.

.. image:: ./images/identifyEdit.jpg
  :align: center
  :width: 50%

.. note::

  Attribute editing has important consequences:

  * The affected layers must be :ref:`processed <layer_preprocess>` again so the attribute change takes effect in the elements included in the layer. Also, the resistance map and other results must also be recalculated.

  * Attribute value changes affect the :ref:`base dataset <base_dataset_project_layers>` from which layers in different project may take their data, so all the projects using the modified data will change if their layers are reprocessed. This may be specially dangerous when editing WFS layers. A lot of projects and users may depend on the service data, so be careful with these changes and notify affected users.


.. _streetview:

StreetView tool
===============

Sometimes it is convenient to check the situation on the ground to verify the constraints provided by the data sources. Some elements like existing lines, buildings, etc. might be different than we expected, or we might need to check their type or precise location.

The Street View by Google comes in handy to do these quick checks. Just click on a street or road where StreetView is available (unfortunately, the available areas are not displayed).

.. image:: ./images/streetViewMenu.jpg
  :align: center
  :width: 30%

|

.. image:: ./images/streetView.jpg
  :align: center
  :width: 80%

This tools works in both the 2D and 3D views.


.. _presentation_view: 

Presentation view
=================

This option in the View menu can be used to simplify the project viewer interface for public presentation purposes.

.. image:: ./images/presentation.jpg
  :align: center
  :width: 80%

Its effect is to hide some user interface elements like the right panel, menus and layer resistance information.

Touch-based interaction in Pathfinder has also been improved to ease the use of this kind of displays.

.. image:: ./images/presentationView.jpg
  :align: center
  :width: 30%

To exit this mode, press the key combination *<Ctrl> + <Alt> + P*.


.. include:: footer.rst