docs(#18): updated the user guide with the reviewed comments, moved s…

…creenshots to public/img

#18

README.md

@@ -65,5 +65,5 @@ npm run test
 ```
 
 ### User Guide
-For a complete User Guide to fundamentals and all functionality click [here](src/UserGuide/Userguide.md).
+For a complete user guide on fundamentals and all functionality click [here](Userguide.md).
 

src/UserGuide/Userguide.md → Userguide.md

@@ -1,5 +1,5 @@
 # User Guide
-This is a userguide for all functionality found in Molloy Explorer. For general information and SetUp, see [README](../../README.md)
+This is a user guide for all functionality found in Molloy Explorer. For general information and SetUp, see [README](README.md).
 ## Table of Contents
 - [Fundamentals](#fundamentals)
   - [Moving the viewpoint](#moving-the-viewpoint)
@@ -37,12 +37,12 @@ If you want to move across larger distances, for example look at a point from a
 In the top left corner there are two icons:
 The top icon opens the menu bar and the bottom icon shows and collapses the minimap. Most of the functionalities are located in the menu bar.
 
- <img src="imagesUserGuide/00_icons.png" alt="icons" width="100">
+ <img src="public/img/00_icons.png" alt="icons" width="100">
 
 
 There are eight tabs in the menu bar that can be opened and collapsed by clicking on them.
 
-<img src="imagesUserGuide/01_menuBarTabs.png" alt="tabs" width="400">
+<img src="public/img/01_menuBarTabs.png" alt="tabs" width="400">
 
 ### Elevation Control
 ---
@@ -52,28 +52,31 @@ Use the slider to set the range by clicking and dragging the squares on either e
 Gradient is set to Clamp by default, but can be changed to “Repeat” or “Mirrored Repeat” by clicking on them.
 There are nine different gradient schemes to choose from. These are also selected by clicking on them.
 
-<img src="imagesUserGuide/02_ElevationControlTab.png" alt="ElevationControl" width="400">
+<img src="public/img/02_ElevationControlTab.png" alt="ElevationControl" width="400">
 
-<img src="imagesUserGuide/03_ElevationControlTab.png" alt="ElevationControl" width="400">
+<img src="public/img/03_ElevationControlTab.png" alt="ElevationControl" width="400">
 
 ### Accepted Filter
 ---
-The accepted filter contains one button to change the view to show which datapoints are accepted as part of the seabed, when the elevation control is active. When the “Activate accepted filter” button is pressed, information regarding the coloring of the datapoints is displayed. This data regarding if a point is accepted or not is an attribute to each datapoint and can not be changed.
+The accepted filter contains one button to change the view to show which datapoints are accepted as part of the seabed, when the elevation control is active. When the “Activate accepted filter” button is pressed, accepted points are displayed in white and not accepted points are displayed in black. This data regarding if a point is accepted or not is an attribute of each datapoint and can not be changed.
 
-<img src="imagesUserGuide/04_AcceptedFilter.png" alt="AcceptedFilter" width="400">
+<img src="public/img/04_AcceptedFilter.png" alt="AcceptedFilter" width="400">
 
-<img src="imagesUserGuide/05_AcceptedFilter.png" alt="AcceptedFilter" width="400">
+<img src="public/img/05_AcceptedFilter.png" alt="AcceptedFilter" width="400">
 
 ### Measurements
 ---
 The Measurements tab allows you to measure angles, distances, heights, areas, volumes, and other properties directly within the point cloud. All tools are located in the Measurements tab in the menu bar. You can perform multiple measurements simultaneously, and all results are tracked in the "List of Measurements" section.
 
-<img src="imagesUserGuide/06_Measurements.png" alt="Measurements" width="400">
+For all the measurements below, you stop by right clicking.
+
+<img src="public/img/12_Measurements_updated.jpg" alt="Measurements" width="400">
 
 #### Measure Angle
 To measure angles between points:
 1. Click on the "Measure Angle" icon or text.  
-2. Click three points in the point cloud. A red triangle will appear connecting the points, and the corresponding angle will be displayed.  
+2. Click three points in the point cloud. A red triangle will appear connecting the points, and the corresponding angle will be displayed.
+
 To adjust a point in the triangle, click on the point you want to move, then click a new point in the point cloud.  
 There is no limit to the number of triangles you can display.  
 Measurement details appear in the "List of Measurements" below the menu bar. The default name is "Distance#1"; make sure it is selected when reviewing the data.  
@@ -82,58 +85,68 @@ Measurement details appear in the "List of Measurements" below the menu bar. The
 To inspect a point in the point cloud:
 1. Click the "Inspect Point" icon.  
 2. Click on the point you want to examine.  
+
 The coordinates and other available attributes of that point will be displayed in the corresponding panel.
 
 #### Measure Distance
 To measure the distance between two points:
 1. Click the "Measure Distance" icon.  
-2. Click the first point, then the second point in the point cloud.  
+2. Click the first point, then the second point in the point cloud.
+
 The distance between the points will be displayed, and a connecting line will appear.  
 To adjust points, click the point and select a new location.
 
 #### Measure Height
 To measure vertical height differences:
 1. Click the "Measure Height" icon.  
-2. Click the lower point first, then the higher point.  
+2. Click the lower point first, then the higher point.
+
 The vertical distance will be displayed.
 
 #### Circle
 To measure a circle:
 1. Click the "Circle" icon.  
-2. Click the center point, then a point on the circumference.  
+2. Click the center point, then a point on the circumference.
+
 The radius and circumference will be displayed.
 
 #### Azimuth
 To measure azimuth (direction relative to north):
 1. Click the "Azimuth" icon.  
-2. Click the starting point, then the ending point.  
+2. Click the starting point, then the ending point.
+
 Azimuth measures the directional angle in degrees between two points relative to true north.
 
 #### Area
 To measure a polygonal area:
 1. Click the "Area" icon.  
 2. Click points to form the vertices of the polygon.  
 3. Double-click the last point to complete the polygon.  
+
 The calculated area will be displayed.
 
 #### Volume
 To measure a 3D volume:
 1. Click the "Volume" icon.  
 2. Select points to define the base polygon of the volume.  
-3. Click an additional point to define the top plane (height).  
+3. Click an additional point to define the top plane (height).
+
 The volume enclosed by the selected points will be calculated.
 
 #### Sphere Volume
 To measure a sphere’s volume:
 1. Click the "Sphere Volume" icon.  
-2. Click the center point of the sphere, then a point on the surface to define the radius.  
+2. Click the center point of the sphere, then a point on the surface to define the radius. 
+
 The sphere volume will be displayed.
 
 #### 2D Height Profile
 To generate a 2D height profile along a line:
 1. Click the "2D Height Profile" icon.  
-2. Click the starting point of the profile line, then click the ending point.  
-The profile line will appear, and a 2D plot of height along the line will be displayed.  
+2. Click the starting point of the profile line, then click the ending point. 
+3. Click the "show 2D profile".
+
+A 2D plot of height along the line will be displayed.  
 You can hover over or click points on the profile to see specific elevation values.  
 Multiple profile lines can be drawn for comparison.  
 To adjust the profile line, select a point and move it to a new location.
@@ -144,13 +157,15 @@ Click the "Remove All" icon to clear all measurements currently displayed in the
 #### Deleting Measurements
 To delete individual measurements:
 1. Select the measurement in the "List of Measurements".  
-2. Click the red "x" icon next to the measurement.  
+2. Click the red "x" icon next to the measurement.
+
 This applies to all measurement types including angles, distances, heights, areas, volumes, spheres, circles, azimuths, and 2D height profiles.
 
-#### Show/Hide Labels
-To show or hide labels for measurements:
-1. Click the "Show Labels" button to display labels for all measurements currently in the scene.  
-2. Click the "Hide Labels" button to hide all measurement labels without deleting the measurements themselves.  
+#### Values/Names/Hide All Labels
+To show or hide Values or Names for measurements:
+1. Click the "Values" or "Names" button to display it for all measurements currently in the scene.  
+2. Click the "Hide All" button to hide all measurement labels without deleting the measurements themselves.
+
 This applies to all measurement types, including angles, distances, heights, areas, volumes, spheres, circles, azimuths, and 2D height profiles.
 
 #### List of Measurements
@@ -160,9 +175,9 @@ All measurements are tracked in the "List of Measurements" panel at the bottom o
 ---
 The Saved Locations tab allows you to quickly navigate to specific points or viewpoints that you have saved within the scene. Annotations can also be created here to mark points of interest. By default, annotation labels are visible in the point cloud and on the map, making it easy to locate important areas.  
 
-<img src="imagesUserGuide/07_SavedLocations.png" alt="SavedLocations" width="400">
+<img src="public/img/07_SavedLocations.png" alt="SavedLocations" width="400">
 
-<img src="imagesUserGuide/11_SavedLocations.png" alt="SavedLocations" width="400">
+<img src="public/img/11_SavedLocations.png" alt="SavedLocations" width="400">
 
 #### Show/Hide Annotations
 Below the list of annotations, there are toggle buttons to show or hide all annotation labels in the point cloud. Use this to declutter the view or focus on specific points as needed.
@@ -171,6 +186,7 @@ Below the list of annotations, there are toggle buttons to show or hide all anno
 To create an annotation:
 1. Click the "Add a Location" button in the Saved Locations section.  
 2. Click on a point in the point cloud.  
+
 As you hover over points, an annotation label will appear above the cursor to indicate that a point can be selected.  
 The annotation will be added to a list right below the "Add a Location" button upon creation.
 
@@ -183,13 +199,14 @@ Each annotation in the list has three icons:
 To add a description to an annotation:
 1. Click the annotation text in the Saved Locations list.  
 2. Click the pen icon next to "Annotation Description".  
+
 The point coordinates and the current camera coordinates will be displayed below the description field.
 
 ### Appearance
 ---
 The Appearance tab allows you to adjust the visual rendering and display settings of the point cloud and scene to optimize clarity, performance, and visual preference.  
 
-<img src="imagesUserGuide/08_Appearance.png" alt="Appearance" width="400">
+<img src="public/img/08_Appearance.png" alt="Appearance" width="400">
 
 #### Point Budget
 The Point Budget controls the maximum number of points rendered at any time.  
@@ -228,7 +245,7 @@ The Background setting controls the scene’s visual backdrop. Options include:
 ---
 The Tools section is located in the menu bar and contains functionalities for clipping, navigation, camera control, and speed adjustment. Clicking on a tool will open the corresponding options.  
 
-<img src="imagesUserGuide/09_Tools.png" alt="Tools" width="400">
+<img src="public/img/09_Tools.png" alt="Tools" width="400">
 
 #### Clipping
 
@@ -300,8 +317,6 @@ Camera projection defines how depth and distance are perceived in the 3D view.
 - **Perspective**  
   Standard 3D view where objects appear smaller as they get farther away. This view simulates how humans naturally perceive depth.
 
-- **Orthographic**  
-  Objects maintain the same size regardless of distance. This is useful for technical inspections, measurements, or plan views where perspective distortion is not desired.
 
 #### Speed
 
@@ -318,7 +333,7 @@ This section ensures that all users can efficiently navigate and manipulate the
 ---
 The Scene tab allows you to manage and organize all the elements currently loaded in the application. It provides tools to view, modify, and export components such as point clouds, measurements, annotations, and other objects, giving you complete control over the content of your 3D environment.
 
-<img src="imagesUserGuide/10_Scene.png" alt="Scene" width="400">
+<img src="public/img/10_Scene.png" alt="Scene" width="400">
 
 #### Export
 The Export feature allows you to save elements from the scene into different file formats for external use:  
@@ -329,8 +344,8 @@ The Export feature allows you to save elements from the scene into different fil
 #### Objects
 The Objects section lists all items currently present in the scene, grouped into categories:  
 - **Point Clouds** – Displays all loaded point clouds in the scene. You can toggle visibility, inspect properties, or remove them.  
-- **Measurements** – Shows all measurements currently in the scene, including angles, distances, heights, areas, volumes, and 2D height profiles.  
-- **Annotations** – Displays any annotations added to the scene, allowing for review or modification.  
+- **Measurements** – See [Measurements panel](#measurements).
+- **Annotations** – See [Saved Locations panel](#saved-locations).
 - **Other** – Contains additional scene elements:  
   - **Camera** – Tracks the position and orientation of the current viewpoint.  
 - **Vectors** – Displays any vector elements present in the scene.  
@@ -353,7 +368,7 @@ General information regarding the application, licences, contributors and more w
 ## Minimap
 The map icon below the menu bar icon in the top left corner, will show and collapse a minimap.
 In the minimap you can zoom using the mouse, touchpad or the icons in the top left corner.
-You can move around by clicking and moving the mouse around simultaneously.
+You can move around by clicking and moving the mouse around simultaneously. The coordinates your cursor hover over will show up in the top right corner of the minimap.
 
 ## Coordinates
-In the bottom right corner there is a black box that lists coordinates. These coordinates correspond to the target point, which is continuously updated to be the most recent point the user has clicked on. Latitude and longitude are measured in degrees, while elevation is measured in metres from the surface level.
+In the bottom right corner there is a black box that lists coordinates. These coordinates correspond to the target point, which is continuously updated to be the most recent point the user has double clicked on. Latitude and longitude are measured in degrees, while elevation is measured in metres from the sea level.