From 61dcd55e1afd028518be05bd5910adc9baf90e6a Mon Sep 17 00:00:00 2001 From: Alicia Westad Rasmussen Date: Mon, 10 Nov 2025 09:50:12 +0100 Subject: [PATCH] docs(#18): fixing the user guide #18 --- README.md | 2 +- Userguide.md | 220 +++++++++++++++++++++++++++++++++------------------ 2 files changed, 144 insertions(+), 78 deletions(-) diff --git a/README.md b/README.md index 7862719..8024b97 100644 --- a/README.md +++ b/README.md @@ -65,5 +65,5 @@ npm run test ``` ### User Guide -For a complete user guide on fundamentals and all functionality click [here](Userguide.md). +For a complete user guide on fundamentals and all functionality click [here](Userguide.md). diff --git a/Userguide.md b/Userguide.md index 4261a2c..8a70a5e 100644 --- a/Userguide.md +++ b/Userguide.md @@ -1,6 +1,9 @@ # User Guide + 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) - [Zoom](#zoom) @@ -17,18 +20,20 @@ This is a user guide for all functionality found in Molloy Explorer. For general - [Minimap](#minimap) - [Coordinates](#coordinates) - ## Fundamentals ### Moving the Viewpoint + Left click and hold anywhere on the screen, while moving the mouse or use a second finger on the touchpad to dynamically move the viewpoint. By doing this you can tilt and rotate the viewpoint. ### Zoom + To zoom in and out the user can either: Utilize the scroll wheel on a mouse. Drag two fingers on the touchpad towards each other or away from each other. ### Move + To move within the application, double click on a point you wish to explore further and you will automatically be moved closer to that point. If you want to move across larger distances, for example look at a point from a different point cloud, it is recommended to zoom out first and then double click on a point closer to where you want to be positioned. @@ -39,13 +44,14 @@ The top icon opens the menu bar and the bottom icon shows and collapses the mini icons - There are eight tabs in the menu bar that can be opened and collapsed by clicking on them. tabs ### Elevation Control + --- + Elevation control applies gradients based on the elevation of the data points. By default elevation control is active. The “Activate elevation control” button will be visible and can be pressed after looking at the Accepted Filter to reset the view back to default. See image below. Use the slider to set the range by clicking and dragging the squares on either end of the scale. @@ -57,7 +63,9 @@ There are nine different gradient schemes to choose from. These are also selecte ElevationControl ### 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, 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. AcceptedFilter @@ -65,7 +73,9 @@ The accepted filter contains one button to change the view to show which datapoi AcceptedFilter ### 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. For all the measurements below, you stop by right clicking. @@ -73,77 +83,97 @@ For all the measurements below, you stop by right clicking. Measurements #### Measure Angle + To measure angles between points: -1. Click on the "Measure Angle" icon or text. + +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. 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. +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. #### Inspect Point + To inspect a point in the point cloud: -1. Click the "Inspect Point" icon. -2. Click on the point you want to examine. + +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. + +1. Click the "Measure Distance" icon. 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. + +1. Click the "Measure Height" icon. 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. + +1. Click the "Circle" icon. 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. + +1. Click the "Azimuth" icon. 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. + +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. + +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). 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. + +1. Click the "Sphere Volume" icon. +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. + +1. Click the "2D Height Profile" icon. +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. @@ -152,98 +182,125 @@ Multiple profile lines can be drawn for comparison. To adjust the profile line, select a point and move it to a new location. #### Remove All + Click the "Remove All" icon to clear all measurements currently displayed in the scene. This will remove all lines, polygons, volume measurements, height profiles, and labels at once. #### Deleting Measurements + To delete individual measurements: -1. Select the measurement in the "List of Measurements". + +1. Select the measurement in the "List of Measurements". 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. #### 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. + +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 + All measurements are tracked in the "List of Measurements" panel at the bottom of the menu bar. Each measurement can be selected to view detailed information or deleted individually. This list provides an easy way to manage multiple measurements in a large point cloud. ### Saved Locations + --- -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. + +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. SavedLocations SavedLocations #### 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. #### Creating an Annotation + 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. + +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. #### Managing Annotations -Each annotation in the list has three icons: -- **Pen Icon** – Rename the annotation or edit its description. -- **Arrow Icon** – Move the camera to the annotation from anywhere in the scene. + +Each annotation in the list has three icons: + +- **Pen Icon** – Rename the annotation or edit its description. +- **Arrow Icon** – Move the camera to the annotation from anywhere in the scene. - **Red X Icon** – Delete the annotation. 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". + +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. + +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. Appearance #### Point Budget -The Point Budget controls the maximum number of points rendered at any time. -- Adjustable using a slider ranging from **100,000 to 10,000,000 points**. + +The Point Budget controls the maximum number of points rendered at any time. + +- Adjustable using a slider ranging from **100,000 to 10,000,000 points**. - Higher values provide more detail but may impact performance, while lower values improve performance at the cost of detail. #### Field of View -The Field of View (FOV) controls the camera’s viewing angle. -- Adjustable using a slider ranging from **20° to 100°**. + +The Field of View (FOV) controls the camera’s viewing angle. + +- Adjustable using a slider ranging from **20° to 100°**. - A wider FOV shows more of the scene but may distort perspective, while a narrower FOV provides a more focused view. #### Eye-Dome Lighting (EDL) -Eye-Dome Lighting enhances depth perception by shading points based on their relative distance. -- **Enable Checkbox** – Turn EDL on or off. -- **Radius Slider** – Adjusts the size of the area used to calculate shading. -- **Strength Slider** – Controls the intensity of the depth effect. + +Eye-Dome Lighting enhances depth perception by shading points based on their relative distance. + +- **Enable Checkbox** – Turn EDL on or off. +- **Radius Slider** – Adjusts the size of the area used to calculate shading. +- **Strength Slider** – Controls the intensity of the depth effect. - **Opacity Slider** – Adjusts the transparency of the shading effect. #### Background -The Background setting controls the scene’s visual backdrop. Options include: -- **Skybox** – A textured 3D background simulating a sky. -- **Gradient** – Smooth transition between two colors. -- **Black** – Solid black background. -- **White** – Solid white background. + +The Background setting controls the scene’s visual backdrop. Options include: + +- **Skybox** – A textured 3D background simulating a sky. +- **Gradient** – Smooth transition between two colors. +- **Black** – Solid black background. +- **White** – Solid white background. - **Globe** – Displays the Earth or a globe representation, this is the default. #### Other Settings -- **Splat Quality** – Adjusts the rendering quality of point splats: - - **Standard** – Default quality, optimized for performance. - - **High Quality** – Improved visual detail, may impact performance. -- **Min Node Size** – Controls the smallest size of nodes rendered in the point cloud. -- **Box** – Toggle the visibility of bounding boxes around point clouds or objects. + +- **Splat Quality** – Adjusts the rendering quality of point splats: + - **Standard** – Default quality, optimized for performance. + - **High Quality** – Improved visual detail, may impact performance. +- **Min Node Size** – Controls the smallest size of nodes rendered in the point cloud. +- **Box** – Toggle the visibility of bounding boxes around point clouds or objects. - **Lock View** – Keeps the bounding boxes or other visual guides in a fixed position. ### Tools + --- -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. + +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. Tools @@ -265,18 +322,18 @@ Clipping allows you to focus on specific regions of the point cloud or dataset b #### Clip Task -The Clip Task determines what happens to the points in the clipping area: +The Clip Task determines what happens to the points in the clipping area: -- **None**: No changes are applied to the points within the clip volume. -- **Highlight**: Points within the clipping area are highlighted to make them easier to see. -- **Inside**: Only points inside the clipping area remain visible; all others are hidden. -- **Outside**: Only points outside the clipping area remain visible; all points inside are hidden. +- **None**: No changes are applied to the points within the clip volume. +- **Highlight**: Points within the clipping area are highlighted to make them easier to see. +- **Inside**: Only points inside the clipping area remain visible; all others are hidden. +- **Outside**: Only points outside the clipping area remain visible; all points inside are hidden. #### Clip Method -When multiple clipping volumes are active, the Clip Method determines how they are combined: +When multiple clipping volumes are active, the Clip Method determines how they are combined: -- **Inside Any**: Points inside any of the clipping volumes will be affected. This creates a union of all clipping areas. +- **Inside Any**: Points inside any of the clipping volumes will be affected. This creates a union of all clipping areas. - **Inside All**: Points must be inside all defined clipping volumes to be affected. This creates an intersection of all volumes. #### Navigation @@ -317,58 +374,67 @@ 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. - #### Speed The Speed control adjusts how fast the camera or navigation responds to user inputs. -- Increasing speed makes zooming, panning, and flying faster, which is useful for exploring large datasets quickly. +- Increasing speed makes zooming, panning, and flying faster, which is useful for exploring large datasets quickly. - Decreasing speed allows for precise adjustments when inspecting small details or measuring specific points. -- The speed will be adjusted automatically when you zoom in and out, providing a more intuitive navigation experience. +- The speed will be adjusted automatically when you zoom in and out, providing a more intuitive navigation experience. This section ensures that all users can efficiently navigate and manipulate the point cloud data, while providing control over the view, clipping, and camera behaviour. - ### Scene + --- + 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. Scene #### Export -The Export feature allows you to save elements from the scene into different file formats for external use: -1. **JSON** – Exports the scene configuration and metadata for use in other applications or for project backup. -2. **DXF** – Exports measurements and geometry into a CAD-compatible format. -3. **Potree** – Exports the point cloud and scene data into a Potree-compatible format for web-based visualization. + +The Export feature allows you to save elements from the scene into different file formats for external use: + +1. **JSON** – Exports the scene configuration and metadata for use in other applications or for project backup. +2. **DXF** – Exports measurements and geometry into a CAD-compatible format. +3. **Potree** – Exports the point cloud and scene data into a Potree-compatible format for web-based visualization. #### 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. + +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** – 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. -- **Images** – Shows any images linked to points or objects in the scene. +- **Other** – Contains additional scene elements: + - **Camera** – Tracks the position and orientation of the current viewpoint. +- **Vectors** – Displays any vector elements present in the scene. +- **Images** – Shows any images linked to points or objects in the scene. #### Properties -The Properties panel provides detailed information about the selected object in the scene. Depending on the object type, you can view: -- Coordinates and dimensions -- Colors and intensity values -- Metadata and attributes -- Visibility and rendering settings -This section gives you full control over the content, allowing you to inspect, modify, or export scene elements efficiently. +The Properties panel provides detailed information about the selected object in the scene. Depending on the object type, you can view: +- Coordinates and dimensions +- Colors and intensity values +- Metadata and attributes +- Visibility and rendering settings + +This section gives you full control over the content, allowing you to inspect, modify, or export scene elements efficiently. ### About + --- + General information regarding the application, licences, contributors and more will show up here. This is default information from Potree. ## 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. 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 double clicked on. Latitude and longitude are measured in degrees, while elevation is measured in metres from the sea level. \ No newline at end of file + +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.