Skip to content

Commit

Permalink
some sidebar tuff
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanKr committed Sep 13, 2024
1 parent 4426d03 commit 317c32b
Show file tree
Hide file tree
Showing 21 changed files with 86 additions and 12 deletions.
10 changes: 5 additions & 5 deletions src/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <img style="vertical-align:middle" src="images/place.png" alt="Place Tool Icon" height="20em"/> which allows you to place one of the following objects:
The default tool is the [place](tools/place.md) tool <img style="vertical-align:middle" src="tools/images/place.png" alt="Place Tool Icon" height="20em"/> 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
Expand All @@ -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 <img style="vertical-align:middle" src="images/move.png" alt="Move Tool Icon" height="20em"/>. 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 <img style="vertical-align:middle" src="images/resize_wall.png" alt="Resize Tool Icon" height="20em"/>.
In the [tool bar](ui/toolbar.md) select the [move](tools/move.md) tool <img style="vertical-align:middle" src="tools/images/move.png" alt="Move Tool Icon" height="20em"/>. 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 <img style="vertical-align:middle" src="tools/images/resize_wall.png" alt="Resize Tool Icon" height="20em"/>.

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.
Binary file removed src/images/move.png
Binary file not shown.
Binary file removed src/images/place.png
Binary file not shown.
Binary file removed src/images/resize_wall.png
Binary file not shown.
2 changes: 1 addition & 1 deletion src/objects/microphone.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 0 additions & 1 deletion src/plots/frequency.md

This file was deleted.

1 change: 0 additions & 1 deletion src/plots/volume.md

This file was deleted.

Binary file removed src/ui/images/move.png
Binary file not shown.
Binary file added src/ui/images/outline.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed src/ui/images/place.png
Binary file not shown.
File renamed without changes
Binary file removed src/ui/images/resize_wall.png
Binary file not shown.
Binary file removed src/ui/images/select.png
Binary file not shown.
Binary file added src/ui/images/tool-options-other.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/ui/images/tool-options-source.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/ui/images/tool-options-wall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
29 changes: 29 additions & 0 deletions src/ui/outline.md
Original file line number Diff line number Diff line change
@@ -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

<p style="margin-bottom: 0px; text-align:center">
<img src="images/outline.png" alt="Outline Panel" />
<div style="width: 100%; text-align: center; color: #a6a7b8; font-size: 14px;">
Outline panel with multiple objects
</div>
</p>

## Highlight Features

When selecting an object in the render area using the [select](../tools/select.md) <img style="vertical-align:middle" src="../tools/images/select.png" alt="Move Tool Icon" height="20em"/> or [move](tools/move.md) <img style="vertical-align:middle" src="../tools/images/move.png" alt="Move Tool Icon" height="20em"/> 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.
6 changes: 6 additions & 0 deletions src/ui/sidebar.md
Original file line number Diff line number Diff line change
@@ -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)
41 changes: 41 additions & 0 deletions src/ui/tool_options.md
Original file line number Diff line number Diff line change
@@ -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 <img style="vertical-align:middle" src="../tools/images/place.png" alt="Move Tool Icon" height="20em"/>.

<p style="margin-bottom: 0px; text-align:center">
<img src="images/tool-options-other.png" alt="Tool without tool options" />
<div style="width: 100%; text-align: center; color: #a6a7b8; font-size: 14px;">
Tool without tool options
</div>
</p>

## 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

<p style="margin-bottom: 0px; text-align:center">
<img src="images/tool-options-source.png" alt="Tool Options Wall" />
<div style="width: 100%; text-align: center; color: #a6a7b8; font-size: 14px;">
Tool options for source placing
</div>
</p>

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.

<p style="margin-bottom: 0px; text-align:center">
<img src="images/tool-options-wall.png" alt="Tool Options Wall" />
<div style="width: 100%; text-align: center; color: #a6a7b8; font-size: 14px;">
Tool options for rectangle wall
</div>
</p>

8 changes: 4 additions & 4 deletions src/ui/toolbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- <img style="vertical-align:middle" src="images/select.png" alt="Select Tool Icon" height="20em"/> [Select](../tools/select.md)
- <img style="vertical-align:middle" src="images/place.png" alt="Place Tool Icon" height="20em"/> [Place](../tools/place.md)
- <img style="vertical-align:middle" src="images/move.png" alt="Move Tool Icon" height="20em"/> [Move](../tools/move.md)
- <img style="vertical-align:middle" src="images/resize_wall.png" alt="Resize Tool Icon" height="20em"/> [Resize](../tools/resize.md)
- <img style="vertical-align:middle" src="../tools/images/select.png" alt="Select Tool Icon" height="20em"/> [Select](../tools/select.md)
- <img style="vertical-align:middle" src="../tools/images/place.png" alt="Place Tool Icon" height="20em"/> [Place](../tools/place.md)
- <img style="vertical-align:middle" src="../tools/images/move.png" alt="Move Tool Icon" height="20em"/> [Move](../tools/move.md)
- <img style="vertical-align:middle" src="../tools/images/resize_wall.png" alt="Resize Tool Icon" height="20em"/> [Resize](../tools/resize.md)

0 comments on commit 317c32b

Please sign in to comment.