Skip to content
Act on suggestions for howto wiki (#131) authored by NorthernSeaCharting's avatar NorthernSeaCharting
- Add terms in README.md in order to better describe certain terms used in the wiki

- Add chapters overview in the README.md so the site becomes easier to navigate

- Remove useless headlines

- Add information about a setting and settings group previously not mentioned

- Condense and improve information of the Tabs.md page

- Add description of viewer controls to Tabs.md
...@@ -3,7 +3,7 @@ windows with a specific function. This enables the user to access multiple featu ...@@ -3,7 +3,7 @@ windows with a specific function. This enables the user to access multiple featu
in a dedicated view. All the tabs of the application can be accessed and turned off again in a dedicated view. All the tabs of the application can be accessed and turned off again
via the `Window` menu entry. via the `Window` menu entry.
## The Tabs -----
There are a few available tabs in the application. The following list provides There are a few available tabs in the application. The following list provides
a brief overview of the available tabs and their function: a brief overview of the available tabs and their function:
...@@ -16,6 +16,22 @@ This includes rotations, zooming, moving the camera and so on. ...@@ -16,6 +16,22 @@ This includes rotations, zooming, moving the camera and so on.
This view will be grayed out, when no trajectory has been loaded and only become This view will be grayed out, when no trajectory has been loaded and only become
available, once a trajectory has been selected and loaded. available, once a trajectory has been selected and loaded.
The viewer can be fully operated via the mouse:
* **Rotating**: You can rotate the view by holding down `Mouse 1` and moving your mouse
* **Moving**: You can move the camera by holding down `Mouse 2` and moving your mouse
* **Zooming**: You can zoom in and out within the viewer by using your `Mousewheel`
However, there are also alternative keyboard controls:
* **Rotating**: There is currently no way to rotate the view with only the keyboard
* **Moving**: You can move the camera via the `Arrow Keys` (`UP` moves the camera up, etc.) or
alternatively you can move the camera sideways via your `A` and `D` keys
* **Zooming**: You can zoom in and out within the viewer by using holding `W` (zooms in) and
by holding `S` (zooms out) on your keyboard
Holding down the `Ctrl` key will increase the speed of the current movement (does not influence rotations).
<br /> <br />
<br /> <br />
...@@ -93,7 +109,7 @@ The camera settings mainly control the camera in the main view of the applicatio ...@@ -93,7 +109,7 @@ The camera settings mainly control the camera in the main view of the applicatio
This control allows switching between two different camera modes: This control allows switching between two different camera modes:
* `First Person Perspective`, in this mode, the camera can be moved around freely * `First Person Perspective`, in this mode, the camera can be moved around freely (as if you were to "walk" through the model)
* `Rotate Around The Center`, with this mode, the camera is locked to the center of the fiber * `Rotate Around The Center`, with this mode, the camera is locked to the center of the fiber
**Camera** **Camera**
...@@ -108,29 +124,30 @@ Under the `camera` portion, there are two distinct controls: ...@@ -108,29 +124,30 @@ Under the `camera` portion, there are two distinct controls:
<br /> <br />
<br /> <br />
### Nucleosomes Explorer ### Explorers
There are a few tabs designated as `explorers` in the application. Each of these serves
to list and configure specific parts or segments of the models (such as linker DNA segments etc.).
#### Nucleosomes Explorer
This tab contains information about every nucleosome of the fiber loaded into the application. Lists and allows to color every nucleosome of the fiber.
Through this view, every nucleosome can be selected and a custom color can be assigned.
<br /> <br />
<br /> <br />
### DNA Explorer #### DNA Explorer
This tab contains information about the DNA around the nucleosomes of the fiber loaded into Lists and allows to color every dna helix of the fiber (excluding `Linker DNA`).
the application. Through this tab, every piece of DNA (excluding `Linker DNA`) can
be assigned a custom color.
<br /> <br />
<br /> <br />
### Linker DNA Explorer #### Linker DNA Explorer
This tab contains information about the Linker DNA of the fiber loaded into Lists and allows to color every segment of linker DNA of the fiber.
the application. Through this tab, every piece of Linker DNA can be assigned a custom color.
<br /> <br />
<br /> <br />
### Cohesin/CTCF Explorer #### Cohesin/CTCF Explorer
Similarly to the other explorer tabs, this tab contains information about the Similarly to the other explorer tabs, this tab contains information about the
`Cohesin` / `CTCF` of the fiber loaded into the application. Through this tab, `Cohesin` / `CTCF` of the fiber loaded into the application. Through this tab,
... ...
......