Side menu and image controls
=============================

The side menu looks as follows

.. image:: img/side_menu.png
   :alt: Program side menu
   :width: 234px
   :align: center

.. note::

   For visual clarity, pressed buttons are highlighted in green

Let us review its functions

Saving and loading settings
---------------------------


.. |save_icon| image:: img/save.png
   :alt: Save settings
   :width: 32px
.. |open_icon| image:: img/open.png
   :alt: Load settings
   :width: 32px

|save_icon| — save zone settings

|open_icon| — load saved zone settings

You can do exactly the same via commands in the :ref:`file` section of the main menu.

.. _screen:

Screenshot
----------

.. |screen_icon| image:: img/screen.png
   :alt: Screenshot
   :width: 32px

The |screen_icon| button allows you to take screenshots with recognition results overlaid.
The resulting images are saved to the folder output/screenshots in :ref:`catalog`.

An example of such an image:

.. image:: img/screenshot.png
   :alt: Screenshot example
   :width: 600px
   :align: center

.. _size:

Position and size control
-------------------------

The remaining buttons in this menu allow you to control the position and size of the image:

|arrow_icon| — shift (left, right, up, down)

|zoom_in_icon| — zoom in

|zoom_out_icon| — zoom out

|reset_icon| — reset to defaults

|rotate_cw_icon| — rotate clockwise

|rotate_ccw_icon| — rotate counterclockwise

|flip_h_icon| — flip horizontally

|flip_v_icon| — flip vertically

The "setup step" slider adjusts how smoothly the position and size of the image will change.

.. |arrow_icon| image:: img/arrow.png
   :alt: shift
   :width: 32px
.. |zoom_in_icon| image:: img/plus.png
   :alt: Zoom in
   :width: 32px
.. |zoom_out_icon| image:: img/minus.png
   :alt: Zoom out
   :width: 32px
.. |reset_icon| image:: img/default.png
   :alt: Reset
   :width: 32px
.. |rotate_cw_icon| image:: img/rotate_1.png
   :alt: Rotate clockwise
   :width: 32px
.. |rotate_ccw_icon| image:: img/rotate_2.png
   :alt: Rotate counterclockwise
   :width: 32px
.. |flip_h_icon| image:: img/h_flip.png
   :alt: Flip horizontally
   :width: 32px
.. |flip_v_icon| image:: img/v_flip.png
   :alt: Flip vertically
   :width: 32px


All these commands can also be executed from the keyboard (arrow keys and "+" and "-"), or with the mouse (press and hold the left mouse button and drag to change position, and use the wheel to change size).

It is also possible to move zones relative to the image using the keys **w, s, a, d** by the value of the **setup step** (in pixels).
The **w, s, a, d** keys move the zones selected in the zone list **up, down, left, right** respectively; at the same time, the zones cannot go beyond the image boundaries.

.. note::

   Attention! If at least one zone is selected in the zone list, a mouse click will lead to reselecting the boundaries for that zone rather than moving the image. To move the image using the mouse, no zones should be selected in the list.

Image area
----------

There are also several additional buttons in the image area.

If the image source is a camera or video, the |play_icon| and |stop_icon| buttons in the lower-left corner allow you to start/stop the video stream.

If the source is a video, a slider also appears at the bottom that allows you to control the current video frame.

The "duplicate" button |duplicate_icon| in the upper-right corner opens additional windows in which the displayed image will be duplicated.

.. |play_icon| image:: img/play.png
   :alt: Start playback
   :width: 16px
.. |stop_icon| image:: img/pause.png
   :alt: Stop playback
   :width: 16px
.. |duplicate_icon| image:: img/duplicate.png
   :alt: Duplicate window
   :width: 16px

.. note::

   A large number of additional windows slows down the program.

The |rocket_icon| and |snail_icon| buttons (rocket and snail) allow you to speed up the program or switch it to normal mode, respectively.
Pressing the rocket button |rocket_icon| pauses frame updates in the main program window, but frame updates continue in the additional windows. Pressing the snail |snail_icon| returns the program to normal mode.

.. |rocket_icon| image:: img/rocket.png
   :alt: Acceleration mode (rocket)
   :width: 16px
.. |snail_icon| image:: img/snail.png
   :alt: Normal mode (snail)
   :width: 16px

.. note::

   Rocket mode can noticeably speed up frame processing if the processed video stream has a high resolution and the computer lacks sufficient resources for fast processing. Updating frames in the main window requires more computing power because it requires converting the image type, which is not required for additional windows.