Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
JonathanKr committed May 29, 2024
2 parents 5ab627e + 4891ee2 commit 66dc0ca
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 4 deletions.
2 changes: 1 addition & 1 deletion src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
- [Toolbar](./ui/toolbar.md)
- [Sidebar](./ui/sidebar.md)
- [Outline](./ui/outline.md)
- [Tool Settings](./ui/tool_settings.md)
- [Tool Options](./ui/tool_options.md)
- [Quick Settings](./ui/quick_settings.md)
- [Preferences](./ui/preferences.md)
- [About](./ui/about.md)
Expand Down
2 changes: 1 addition & 1 deletion src/objects/source.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Source

Sources are the only sound emitters available in wavefront. They emit sound in all directions and can be placed anywhere in the [render area](../ui/render_area.md). Each source is can be assigned a number of properties such as frequency, amplitude and phase depending on the waveforms used.
Sources are the only sound emitters available in wavefront. They emit sound in all 4 directions (top, left, right, bottom) and can be placed anywhere in the [render area](../ui/render_area.md). Each source is can be assigned a number of properties such as frequency, amplitude and phase depending on the waveforms used.

The following waveforms are available for sources:
- [Sine](#sine)
Expand Down
2 changes: 1 addition & 1 deletion src/ui/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Wavefronts interface can be separated into seven main areas. Six of those areas
* The topbar at the very top is used to save, load and screenshot a simulation as well as to access the preferences and keybinds.
* [Outline](./outline.md) (2 & green)
* The outline at the left lists all objects in the scene and offers more settings per object
* [Tool Settings](./tool_settings.md) (3 & lightblue)
* [Tool Options](./tool_options.md) (3 & lightblue)
* The tool settings at the bottom left are used to change tool specific settings
* [Quick Settings](./quick_settings.md) (4 & lightpurple)
* The quicksettings at the bottom left offer important settings for the overall simulation
Expand Down
1 change: 1 addition & 0 deletions src/ui/options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Tool Options
13 changes: 13 additions & 0 deletions src/ui/render_area.md
Original file line number Diff line number Diff line change
@@ -1 +1,14 @@
# Render Area

The render area is the main area of the user interface where you can interact with the room and its objects. The render area is also where you can place, move, resize, and delete objects. The visual representation (the texture) of the render area scales with the size of the window. However the underlying data (the simulation itself) is done in a 700x700 grid. Due to this, artifacts may appear at some resolutions.

## Gizmos
Gizmos appear for each object, when you hover over the area. To get a better view of the simulation, you can hide the gizmos simply by hovering over a different area of the screen.

## Gradients

Rendering happens each frame of the UI-Thread (VSynced to your monitor, usually 60Hz). The simulation is done at a variable rate, chosen by you (see [Quick Settings](./quick_settings.md)). During rendering all pressure values in each cell of the grid are used to lookup a color in a gradient. The gradient can be changed in the [Preferences](./preferences.md).

## Gamma Correction

The pixel buffer used ([bevy_pixel_buffer](https://github.com/Zheoni/bevy_pixel_buffer)) for rendering is in linear color space. This means that the colors are not gamma corrected. To correct this, a gamma correction is applied to the gradient colors using the gamma value 2.2.
1 change: 1 addition & 0 deletions src/ui/tool_options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Tool Options
1 change: 0 additions & 1 deletion src/ui/tool_settings.md

This file was deleted.

7 changes: 7 additions & 0 deletions src/ui/toolbar.md
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
# Toolbar

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](../tools/select.md)
- [Place](../tools/place.md)
- [Move](../tools/move.md)
- [Resize](../tools/resize.md)

0 comments on commit 66dc0ca

Please sign in to comment.