diff --git a/src/getting_started.md b/src/getting_started.md index d8ce43a..57476b6 100644 --- a/src/getting_started.md +++ b/src/getting_started.md @@ -6,9 +6,9 @@ Having either downloaded a pre-build binary or build wavefront from source you a You should be greeted by this window: -![Wavefront UI](images/wavefront-main.png) +![Wavefront UI](ui/images/wavefront-main.png) -The default tool is the [place](tools/place.md) tool Place Tool Icon which allows you to place one of the following objects: +The default tool is the [place](tools/place.md) tool Place Tool Icon which allows you to place one of the following objects: - [Source](objects/source.md) - [Rectangular](objects/rect_wall.md) or [circular](objects/circ_wall.md) wall @@ -18,14 +18,14 @@ As show in the [tool option](ui/tool_settings.md) panel `Source` is selected mea Press `space` or click the `Start` button to run the simulation. Press `space` again to stop. -In the [tool bar](ui/toolbar.md) select the [move](tools/move.md) tool Move Tool Icon. This tool allows you move any object contained in the render area. If you feel like experimenting try placing a wall and resizing it using the [resize](tools/resize.md) tool Resize Tool Icon. +In the [tool bar](ui/toolbar.md) select the [move](tools/move.md) tool Move Tool Icon. This tool allows you move any object contained in the render area. If you feel like experimenting try placing a wall and resizing it using the [resize](tools/resize.md) tool Resize Tool Icon. Currently the simulation is reset every time you move or change an object. To disable this behavior uncheck `Reset on change` in the [quick settings](ui/quick_settings.md) menu. All objects can be further customized in the [outline](ui/outline.md) panel. -While the [render area](./ui/render_area.md) displays the simulation, microphones give the user a more in depth visualization of the simulation properties by displaying sound volume and frequency in the [volume](plots/volume.md) and [frequency](plots/frequency.md) plots. After placing a microphone enable the plots using the `Show Plots` checkbox. +While the [render area](./ui/render_area.md) displays the simulation, microphones give the user a more in depth visualization of the simulation properties by displaying sound volume and frequency in the [volume](ui/plots/volume.md) and [frequency](ui/plots/frequency.md) plots. After placing a microphone enable the plots using the `Show Plots` checkbox. -![Wavefront UI](images/plot-example.png) +![Wavefront UI](ui/images/plot-example.png) Also check out our list of [keybinds](ui/keybinds.md) for more efficient use of wavefront. diff --git a/src/images/move.png b/src/images/move.png deleted file mode 100644 index d5e1ef2..0000000 Binary files a/src/images/move.png and /dev/null differ diff --git a/src/images/place.png b/src/images/place.png deleted file mode 100644 index e11f0ea..0000000 Binary files a/src/images/place.png and /dev/null differ diff --git a/src/images/resize_wall.png b/src/images/resize_wall.png deleted file mode 100644 index ce98182..0000000 Binary files a/src/images/resize_wall.png and /dev/null differ diff --git a/src/objects/microphone.md b/src/objects/microphone.md index 04ff955..9d4423c 100644 --- a/src/objects/microphone.md +++ b/src/objects/microphone.md @@ -2,4 +2,4 @@ Microphones are used to inspect the sound field (and its pressure) at a specific point in the [render area](../ui/render_area.md). They can be placed anywhere inside it. -The output of a microphone is a time series of the sound pressure at its location. To visualize this as a plot or perform a fourier transform, you can use the [Volume](../plots/volume.md) or [Frequency](../plots/frequency.md) plots respectively. +The output of a microphone is a time series of the sound pressure at its location. To visualize this as a plot or perform a fourier transform, you can use the [Volume](../ui/plots/volume.md) or [Frequency](../ui/plots/frequency.md) plots respectively. diff --git a/src/plots/frequency.md b/src/plots/frequency.md deleted file mode 100644 index 48db6d6..0000000 --- a/src/plots/frequency.md +++ /dev/null @@ -1 +0,0 @@ -# Frequency diff --git a/src/plots/volume.md b/src/plots/volume.md deleted file mode 100644 index ca2c069..0000000 --- a/src/plots/volume.md +++ /dev/null @@ -1 +0,0 @@ -# Volume diff --git a/src/ui/images/move.png b/src/ui/images/move.png deleted file mode 100644 index d5e1ef2..0000000 Binary files a/src/ui/images/move.png and /dev/null differ diff --git a/src/ui/images/outline.png b/src/ui/images/outline.png new file mode 100644 index 0000000..ff8f076 Binary files /dev/null and b/src/ui/images/outline.png differ diff --git a/src/ui/images/place.png b/src/ui/images/place.png deleted file mode 100644 index e11f0ea..0000000 Binary files a/src/ui/images/place.png and /dev/null differ diff --git a/src/images/plot-example.png b/src/ui/images/plot-example.png similarity index 100% rename from src/images/plot-example.png rename to src/ui/images/plot-example.png diff --git a/src/ui/images/resize_wall.png b/src/ui/images/resize_wall.png deleted file mode 100644 index ce98182..0000000 Binary files a/src/ui/images/resize_wall.png and /dev/null differ diff --git a/src/ui/images/select.png b/src/ui/images/select.png deleted file mode 100644 index 8a36fe4..0000000 Binary files a/src/ui/images/select.png and /dev/null differ diff --git a/src/ui/images/tool-options-other.png b/src/ui/images/tool-options-other.png new file mode 100644 index 0000000..2880974 Binary files /dev/null and b/src/ui/images/tool-options-other.png differ diff --git a/src/ui/images/tool-options-source.png b/src/ui/images/tool-options-source.png new file mode 100644 index 0000000..fe6c8c3 Binary files /dev/null and b/src/ui/images/tool-options-source.png differ diff --git a/src/ui/images/tool-options-wall.png b/src/ui/images/tool-options-wall.png new file mode 100644 index 0000000..79988e1 Binary files /dev/null and b/src/ui/images/tool-options-wall.png differ diff --git a/src/images/wavefront-main.png b/src/ui/images/wavefront-main.png similarity index 100% rename from src/images/wavefront-main.png rename to src/ui/images/wavefront-main.png diff --git a/src/ui/outline.md b/src/ui/outline.md index b07251e..07e161c 100644 --- a/src/ui/outline.md +++ b/src/ui/outline.md @@ -1 +1,30 @@ # Outline + +The outline panel is used for changing object settings. The objects are grouped into three groups: + +- [Sources](../objects/source.md) +- [Microphones](../objects/microphone.md) +- [Rectangular](../objects/rect_wall.md) or [circular](../objects/circ_wall.md) walls + +

+ Outline Panel +

+ Outline panel with multiple objects +
+

+ +## Highlight Features + +When selecting an object in the render area using the [select](../tools/select.md) Move Tool Icon or [move](tools/move.md) Move Tool Icon tool the selected objects entry in the outline panel will be expanded. All other entries will close. + +When hovering over a closed entry in the outline panel the corresponding object will be highlighted in the render area. + +When expanding an entry in the outline panel the corresponging object will be highlighted in the render area regardless of cursor position. + +## Delete + +The delete button allows for deletion of an object. This can be reverted using `Ctrl + Z`. + +## Object-Specific Settings + +The parameters specific to each object are detailed on the respective object's page. \ No newline at end of file diff --git a/src/ui/sidebar.md b/src/ui/sidebar.md index 8435811..f801f5f 100644 --- a/src/ui/sidebar.md +++ b/src/ui/sidebar.md @@ -1 +1,7 @@ # Sidebar + +The sidebar panels are used for quickly changing simulation, object and tool settings. The sidebar is separated into the following panels: + +- [Outline](./outline.md) +- [Tool Options](./tool_options.md) +- [Quick Settings](./quick_settings.md) diff --git a/src/ui/tool_options.md b/src/ui/tool_options.md index 4d0ca7a..cebc789 100644 --- a/src/ui/tool_options.md +++ b/src/ui/tool_options.md @@ -1 +1,42 @@ # Tool Options + +The tool options panel is used for customizing a tools behavior. + +## No Tool Options + +When a tool lacking configurable options is selected, the tool options panel will display an alert message. This is the case for all tools expect for the [place](../tools/place.md) tool Move Tool Icon. + +

+ Tool without tool options +

+ Tool without tool options +
+

+ +## Place Tool + +The place tool will allow you to change the object type that is to be placed. A drop-down menu will display in order: + +- Source +- Microphone +- Rectangle Wall +- Circular Wall + +

+ Tool Options Wall +

+ Tool options for source placing +
+

+ +By default `Source` will be selected. You can also use [keybinds](./keybinds.md) to change this setting. + +When selecting either `Rectangle Wall` or `Circular Wall` the tool options panel will show the `Wall reflection factor` and `Hollow` settings. + +

+ Tool Options Wall +

+ Tool options for rectangle wall +
+

+ diff --git a/src/ui/toolbar.md b/src/ui/toolbar.md index 696971d..9f4ecb1 100644 --- a/src/ui/toolbar.md +++ b/src/ui/toolbar.md @@ -2,7 +2,7 @@ The toolbar can be used to quickly change between tools that can be used to interact with the scene. For some tools there are additional options that can be set in the [tool options](tool_options.md) panel. For more information on the tools, see: -- Select Tool Icon [Select](../tools/select.md) -- Place Tool Icon [Place](../tools/place.md) -- Move Tool Icon [Move](../tools/move.md) -- Resize Tool Icon [Resize](../tools/resize.md) +- Select Tool Icon [Select](../tools/select.md) +- Place Tool Icon [Place](../tools/place.md) +- Move Tool Icon [Move](../tools/move.md) +- Resize Tool Icon [Resize](../tools/resize.md)