-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4426d03
commit 317c32b
Showing
21 changed files
with
86 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
File renamed without changes
Binary file not shown.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters