Skip to content
Add README description and replace <br> in most files (#131) authored by NorthernSeaCharting's avatar NorthernSeaCharting
...@@ -16,6 +16,8 @@ This includes rotations, zooming, moving the camera and so on. ...@@ -16,6 +16,8 @@ This includes rotations, zooming, moving the camera and so on.
<br> <br>
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.
<br />
<br />
### PBC ### PBC
...@@ -24,68 +26,78 @@ obtained from the config loaded into the application. ...@@ -24,68 +26,78 @@ obtained from the config loaded into the application.
<br> <br>
The view contains multiple controls that influence the visualisation of the The view contains multiple controls that influence the visualisation of the
trajectory: trajectory:
<br><br>
**PBC-Mode and Container** **PBC-Mode and Container**
<br>
These settings control whether the loaded trajectory will be displayed in PBC-mode These settings control whether the loaded trajectory will be displayed in PBC-mode
and whether the PBC-container will be displayed in the main view. The additional and whether the PBC-container will be displayed in the main view. The additional
`Color` property directly controls the color of the container, if it is displayed in `Color` property directly controls the color of the container, if it is displayed in
the view. the view.
<br><br>
**Microscope Slide** **Microscope Slide**
<br>
The `Microscope Slide` controls influence whether a slide will be displayed The `Microscope Slide` controls influence whether a slide will be displayed
in the main viewer window. Similarly to the PBC container, enabling the `Box` in the main viewer window. Similarly to the PBC container, enabling the `Box`
of the slide, will show a visualisation of the box in the main view. That view's of the slide, will show a visualisation of the box in the main view. That view's
color can also be changed. With the `Size` and `Index` controls, the slide color can also be changed. With the `Size` and `Index` controls, the slide
can be increased in size and moved through the container, changing what is being can be increased in size and moved through the container, changing what is being
included and displayed. included and displayed.
<br />
<br />
### Fiber Information ### Fiber Information
This view contains information about the fiber that has been loaded into the application. This view contains information about the fiber that has been loaded into the application.
<br />
<br />
### Cohesin / CTCF ### Cohesin / CTCF
This view contains information about hte `Cohesin` properties of the loaded fiber. This view contains information about hte `Cohesin` properties of the loaded fiber.
<br />
<br />
### View Settings ### View Settings
This tab describes certain settings that directly influence the visualisation This tab describes certain settings that directly influence the visualisation
of the fiber on display. It is split into two distinct control groups: of the fiber on display. It is split into two distinct control groups:
<br><br>
**Colors** **Colors**
<br>
This control directly influences the color of fiber-elements. For example, the This control directly influences the color of fiber-elements. For example, the
color for the entirety of the nucleosomes can be set. color for the entirety of the nucleosomes can be set.
<br><br>
**Visualization** **Visualization**
<br>
This control group allows activating or hiding helper elements in the main view and This control group allows activating or hiding helper elements in the main view and
influencing some visual properties of the displayed fiber (for example the texture). influencing some visual properties of the displayed fiber (for example the texture).
<br />
<br />
### Configuration Player ### Configuration Player
The configuration player controls which configuration will be displayed in the main The configuration player controls which configuration will be displayed in the main
view of the application. Through the tab, specific configurations can be selected view of the application. Through the tab, specific configurations can be selected
or the autoplay-feature can be used, to cycle through every available config. or the autoplay-feature can be used, to cycle through every available config.
<br>
The tab also allows for other smaller settings to influence the display of and cycling The tab also allows for other smaller settings to influence the display of and cycling
through the configurations. through the configurations.
<br />
<br />
### Camera Settings ### Camera Settings
The camera settings mainly control the camera in the main view of the application. The camera settings mainly control the camera in the main view of the application.
<br><br>
**Controls** **Controls**
<br>
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
* `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**
<br><br>
Under the `camera` portion, there are two distinct controls: Under the `camera` portion, there are two distinct controls:
* `Set Camera` allows setting different camera behaviours for when the configuration in the main view is changed * `Set Camera` allows setting different camera behaviours for when the configuration in the main view is changed
...@@ -93,28 +105,38 @@ Under the `camera` portion, there are two distinct controls: ...@@ -93,28 +105,38 @@ Under the `camera` portion, there are two distinct controls:
* `Set to Center Mass` will place the camera at the origin of the fiber whenever you change configuration * `Set to Center Mass` will place the camera at the origin of the fiber whenever you change configuration
* `Keep Distance to Center` will keep the camera at its current position whenever you change configuration * `Keep Distance to Center` will keep the camera at its current position whenever you change configuration
* `Find The Fiber` is a button that will center the camera of the view on the fiber * `Find The Fiber` is a button that will center the camera of the view on the fiber
<br />
<br />
### Nucleosomes Explorer ### Nucleosomes Explorer
This tab contains information about every nucleosome of the fiber loaded into the application. This tab contains information about every nucleosome of the fiber loaded into the application.
Through this view, every nucleosome can be selected and a custom color can be assigned. Through this view, every nucleosome can be selected and a custom color can be assigned.
<br />
<br />
### DNA Explorer ### DNA Explorer
This tab contains information about the DNA around the nucleosomes of the fiber loaded into This tab contains information about the DNA around the nucleosomes of the fiber loaded into
the application. Through this tab, every piece of DNA (excluding `Linker DNA`) can the application. Through this tab, every piece of DNA (excluding `Linker DNA`) can
be assigned a custom color. be assigned a custom color.
<br />
<br />
### Linker DNA Explorer ### Linker DNA Explorer
This tab contains information about the Linker DNA of the fiber loaded into This tab contains information about the Linker DNA of the fiber loaded into
the application. Through this tab, every piece of Linker DNA can be assigned a custom color. the application. Through this tab, every piece of Linker DNA can be assigned a custom color.
<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,
every `Cohesin` / `CTCF` element can be assigned a custom color. every `Cohesin` / `CTCF` element can be assigned a custom color.
<br />
<br />
### Tool: Color Gradient ### Tool: Color Gradient
... ...
......