.. _interface_overview:

Interface Overview
==================

|UI_1|

The Tahoma2D interface is organized into rooms, also known as workspaces. Each room is a different collection of panels which are laid out at specific positions on the screen for a specific use. 


.. _editing_rooms:

Room Editing Mode
-----------------

|UI_lock| "Room Editing Mode" allows for rooms to be added, removed, and renamed. It also allows for panels to be added, removed, or rearranged. To enter or exit "Room Editing Mode", click on the lock icon on the top right of the workspace.

.. tip:: **How to identify "Room Editing Mode":**

    When "Room Editing Mode" is unlocked, all of the panels have a visible header.
    
.. _using_rooms:

Using Rooms
-----------

|UI_rooms|

Available rooms are listed on the far right of the menu bar. Each room always displays the contents of the current scene.

Rooms can be named and their order can be rearranged. New rooms can be added and existing rooms can be deleted. When a room is added it is empty; to configure it, panels can be added one by one (see below).

To enter a room, click on the related tab on the far right of the menu bar. If "Room Editing Mode" is active, room tabs can be reordered by clicking & dragging the tabs to a new position.


.. tip:: **To name a room:**

    Double-click the tab and type the name you want to assign to the room.

.. tip:: **To add a new room:**

    Right-click in the room tab area and choose New Room from the menu that opens.

.. tip:: **To delete a room:**

    Right-click the room tab and choose Delete Room "<Name>" from the menu that opens. The current room cannot be deleted.

.. tip:: **To return to the set of rooms provided with Tahoma2D:**

    Choose Panels  →  Reset to Default Rooms.


.. _customizing_rooms:

Customizing Rooms
'''''''''''''''''
Rooms can be modified by setting different sizes to different panels. When "Room Editing Mode" is active, docked panels can be pulled out to become floating panels and floating panels can be docked. 

While "Room Editing Mode" is locked, panels can be resized and new floating panels can be added by using the Panels menu.


.. tip:: **To resize a panel in the room:**

    Click any vertical or horizontal separator and drag it to the new position.

.. note:: Some panels like the toolbar have a fixed width or height, therefore they cannot always be resized.

.. tip:: **To open a panel as a floating panel:**

    Select in the Panels menu the panel you want to open.

.. tip:: **To resize a floating panel:**

    Click and drag the border or corner of a panel.

.. tip:: **To close a floating panel or a dialog:**

    Click the close button at the right of the title bar.

.. tip:: **To add a panel to a room:**

    1. Use the Panels menu to open the panel as a floating panel.

    2. Click and drag its title bar to move it around and release to dock it according to the highlighted insertion point.

.. note:: Trying to dock a panel to the leftmost/rightmost part of the interface may fail if the main Tahoma2D window is maximized at that moment. To overcome this, you can restore the main window size, dock the desired panel, and then maximize it back.

.. tip:: **To remove a panel from a room:**

    1. Click and drag the title bar of the panel you want to remove to undock it from the room.

    2. Close the floating panel.

.. tip:: **To maximize, or minimize a panel:**

    Double-click its title bar (for floating panels, the Viewer and the ComboViewer). If there is no title bar, press **`**.

.. note:: Some panels like the toolbar and the command bar have a fixed size in one dimension, therefore they cannot be maximized. 



.. _room_panes:

Room Panels
-----------
Below there is a list of the panels (in the same order in which they appear in the Panels menu) that can be used to build rooms and that can be opened as floating panels.


.. _batch_servers:

Batch Servers
'''''''''''''

|UI_batch|

The Batch Servers panel allows you to process the batch list by using the render farm, and contains information about the list of server (rendering) nodes defined for the farm. 

See  :ref:`Monitoring the Server Nodes <monitoring_the_server_nodes>`  .


.. _cleanup_settings:

Cleanup Settings
''''''''''''''''

|UI_cleanup|

The Cleanup Settings panel allows you to define the parameters for the clean-up process of scanned raster images, in order to convert them into Smart Raster images, ready to be painted in Tahoma2D. 

See  :ref:`Cleaning-up Scanned Drawings <cleaning-up_scanned_drawings>`  .


.. _color_model:

Color Model
'''''''''''

|UI_colormodel|

The color model viewer displays the image, or animation level, you loaded as reference to paint the current animation level.

See  :ref:`Using a Color Model <using_a_color_model>`  .


.. _file_browser:

File Browser
''''''''''''

|UI_filebrowser|

The file browser allows you to load and save files, and to access projects.

On the left there is a file tree with some main folders containing material stored on your computer: My Computer, Network, My Documents, History, Library and Projects. You can open folders and sub-folders in order to retrieve files that are displayed in the area on the right.

See  :ref:`Managing Projects <managing_projects>`  and  :ref:`Using the File Browser <using_the_file_browser>`  .


.. _flipbook:

Flipbook
''''''''

|UI_flipbook|

The flipbook can display animation levels, clips or sequences of images. It can be used to check levels for instance before loading them, or to control a rendered sequence. 

See  :ref:`Using the Flipbook <using_the_flipbook>`  .


.. _function_editor:

Function Editor
'''''''''''''''

|UI_functioneditor|

The function editor maps objects and FX transformations with key values and related interpolations by using a spreadsheet or a graph editor. It is divided into two sections: on the left there is an area where the spreadsheet or graph editor is displayed, on the right top is an area where the interpolation of the current transformation segment is displayed, and on the right bottom is the objects/FX tree.

See  :ref:`Using the Function Editor <using_the_function_editor>`  .


.. _level_strip:

Level Strip
'''''''''''

|UI_levelstrip|

The level strip displays the sequence of drawings belonging to the level currently selected in the Xsheet. 

It helps you to edit the sequence of drawings and to see all the drawings of the current level, even if those drawings are not exposed in a Xsheet. 

See  :ref:`Editing Animation Levels <editing_animation_levels>`  .


.. _palette:

Palette
'''''''

|UI_palette|

It displays the styles defined for the current level, or in case it is inactive the styles defined for a previously selected level.

See  :ref:`The Palette Panel<the_palette_window>`  .


.. _scene_cast:

Scene Cast
''''''''''

|UI_scenecast|

The scene cast panel lets you control the files loaded in the scene, save them and load new ones. It can be organized in folders and sub-folders. 

See  :ref:`Using the Scene Cast <using_the_scene_cast>`  .


.. _schematic:

Schematic
'''''''''

|UI_schematic|

The schematic can alternatively display stage information or special FX usage.

The stage schematic displays as nodes all the objects defined in a scene, i.e. columns, pegbars, cameras, the table and motion paths, and allows you to manage the way they are linked to each other.

The FX schematic allows you to apply FX to the content of Xsheet columns, and to manage the way they are applied. All the columns and FX are displayed as nodes that can be connected in order to set the way FX affect the scene content. 

See  :ref:`Using the Stage Schematic <using_the_stage_schematic>`  and  :ref:`Using the FX Schematic <using_the_fx_schematic>`  .


.. _studio_palette:

Studio Palette
''''''''''''''

|UI_studiopalette|

The studio palette allows you to store an unlimited number of level palettes. From here any palette can be retrieved and assigned to the current level in order to paint it, with no need to define the same styles again and again. It also includes a viewer displaying the styles of the currently selected palette.

See  :ref:`Using the Studio Palette <using_the_studio_palette>`  .


.. _style_editor:

Style Editor
''''''''''''

|UI_styleeditor|

The style editor allows you to modify the palette styles. You can choose the type of style among color, texture, vector and raster. There also is a settings tab where you can decide some parameters for the style.

See  :ref:`Editing Styles <editing_styles>`  .


.. _tasks:

Tasks
'''''

|UI_tasks|

The Tasks panel contains the task tree with all the tasks submitted to the batch processing, and information about the task currently selected in the tree. From the task tree you can start or stop a task execution, or remove it.

See  :ref:`Managing and Executing Render Tasks <managing_and_executing_render_tasks>`  .


.. _message_center:

Message Center
''''''''''''''

|UI_messagecenter|

The message center displays in a list the messages Tahoma2D is sending to the user. You can set filters on the messages showed in the panel using the appropriate radio buttons, or you can clear completely the list pressing the Clear button.


.. _toolbar:

Toolbar
'''''''

|UI_toolbar|

The toolbar contains tools to draw, select and edit drawings, and to animate objects like the camera, columns and pegbars. The tools in the toolbar can only be used in the main viewer. 

.. note:: If the toolbar is too short to display all the tools, it can be scrolled by using arrow buttons available at its ends.

|animate| **Animate** modifies the position, rotation and size of the current objects (see  :ref:`Animating Objects <animating_objects>`  ).




|selection| **Selection** performs a selection and transforms it (see  :ref:`Using the Selection Tool <using_the_selection_tool>`  ).




|brush| **Brush** draws in the work area in freehand mode (see  :ref:`Drawing with the Brush Tool <drawing_with_the_brush_tool>`  ).




|geometric| **Geometry** draws geometric shapes (see  :ref:`Drawing with the Geometric Tool <drawing_with_the_geometric_tool>`  ).




|type| **Type** adds text by setting the font and size (see  :ref:`Adding Text <adding_text>`  ).




|fill| **Fill** fills drawing areas with the current style (see  :ref:`Filling Areas <filling_areas>`  ).




|paint_brush| **Smart Raster Paint** paints lines and areas in Smart Raster drawings in freehand mode. (see  :ref:`Filling Areas <filling_areas>`  ).




|eraser| **Eraser** deletes vectors in vector drawings, and painted areas and lines in raster drawings (see  :ref:`Drawing Tools <drawing_tools>`  ).




|tape| **Tape** joins two open ends of one or two vectors in vector drawings, or closes gaps in raster drawings (see  :ref:`Joining and Splitting <joining_and_splitting>`  ).




|style_picker| **Style Picker** picks a style from the current drawing, that becomes the current style in the palette and in the style editor.




|RGB_picker| **RGB Picker** picks red, green and blue values from the viewer content, and applies them to the current style (see  :ref:`Plain Colors <plain_colors>`  ).




|cpe| **Control Point Editor** modifies the vector shape by editing its control points (see  :ref:`Editing Vector Control Points <editing_vector_control_points>`  ).




|pinch| **Pinch** modifies the vector shape by clicking and dragging anywhere on the vector (see  :ref:`Changing the Bend of Vectors <changing_the_bend_of_vectors>`  ).




|pump| **Pump** locally modifies the vector thickness by clicking on the section you want to affect and then dragging up or down (see  :ref:`Using Other Modifier Tools <using_other_modifier_tools>`  ).




|magnet| **Magnet** deforms several vectors at once by clicking the area you want to affect and dragging (see  :ref:`Using Other Modifier Tools <using_other_modifier_tools>`  ).




|bender| **Bender** bends vectors in vector drawings (see  :ref:`Using Other Modifier Tools <using_other_modifier_tools>`  ).




|iron| **Iron** removes creases from vectors by moving the cursor on the vector you want to flatten (see  :ref:`Using Other Modifier Tools <using_other_modifier_tools>`  ).




|cutter| **Cutter** splits a vector in two sections when clicking on it (see  :ref:`Joining and Splitting <joining_and_splitting>`  ).




|skeleton| **Skeleton** defines character models, and animates them as in cutout animation (see  :ref:`Using the Skeleton Tool <using_the_skeleton_tool>`  )




|tracker| **Tracker** tracks specific regions in a sequence of images (see  :ref:`Tracking Points <tracking_points>`  ).




|hook| **Hook** defines reference points to be used in the stage schematic to move an object, or link one object to another (see  :ref:`Using Hooks <using_hooks>`  ).




|plastic| **Plastic** builds a mesh that allows to deform and animate a character or part of it (see  :ref:`Using Plastic tool <using_plastic_tool>`  ).




|zoom| **Zoom** zooms in and out the viewer content; after you click you can drag up to zoom in the work area, or drag down to zoom out.




|rotate| **Rotate** rotates the viewer content; if the 3D view is activated, the Rotate tool lets you change the point of view.




|hand| **Hand** pans over the viewer content; if the 3D view is activated, the Hand tool lets you pan over the 3D view as well.


.. _tool_options_bar:

Tool Options Bar
''''''''''''''''

|UI_tooloptionsbar|

The tool options bar displays settings for the current tool, if it has any.

For example it lets you set the thickness and other properties of the Brush tool.

.. note:: If the tool options bar is too short to display all the tool options, it can be scrolled by using arrow buttons available at its ends.


.. _command_bar:

Command Bar
'''''''''''

|UI_commandbar|

The Command Bar is a place where the user can display favorite Tahoma2D tools and commands to have them readily available.

The Command Bar panel can be docked in any part of the Tahoma2D UI.

.. note:: If the Command Bar is too short to display all the command buttons, a double-arrow symbol will appear at the right end of it, allowing to display a drop down menu with the rest of them.

.. tip:: **To display the Command Bar:**

    - Choose Panels  →  Command Bar.

.. tip:: **To customize the Command Bar buttons:**

    1. Choose Panels  →  Command Bar to open the Command Bar.

    2. Right click on it and select **Customize Command Bar** from the menu that opens. The Customize Command Bar panel will open.

    |UI_commandbar_window|

    3. To *add* a command: Search for a command in the **Commands** list (left) and drag it to the **Command Bar** list (right).
    
    4. To *add* a separator: At the end of the **Commands** list (left), drag the **----Separator----** item to the **Command Bar** list (right).
    
    5. To *delete* a command: Locate the command in the **Command Bar** list (right), right click on it and select **Remove** from the menu that opens.
    
    6. Click **OK** to accept the changes or **Cancel** to discard them.
    

.. _viewer:

Viewer
''''''

|UI_viewer|

The viewer is the work area where you can draw images and see at the same time the result of your compositing. It is endless and you can scroll, zoom in, zoom out and rotate it the way you prefer.

It has different modes of visualization among which you can choose the more suitable to the operation you are performing.

See  :ref:`Using the Viewer <using_the_work_area>`  and  :ref:`Previewing the Animation <previewing_the_animation>`  .


.. _combo_viewer:

ComboViewer
'''''''''''

|UI_comboviewer|

The comboviewer integrates in a single panel a viewer, horizontal toolbar and a tool options bar.
It's and alternative work area where you can draw images and see at the same time the result of your compositing. It is endless and you can scroll, zoom in, zoom out and rotate it the way you prefer.

It has different modes of visualization among which you can choose the more suitable to the operation you are performing.

See  :ref:`Using the Viewer <using_the_work_area>`  and  :ref:`Previewing the Animation <previewing_the_animation>`  .


.. _xsheet:

Xsheet
''''''

|UI_xsheet|

The Xsheet allows you to manage the scene content, in the same manner as the timeline. It is organized in columns, and columns are divided into cells, representing the content of that column in that particular frame. In the columns you can load animation levels, clips, images, audio files or other Xsheets. 

Each column has its own header containing information about its content. The column on the far left displays the frame number, with a cursor placed on the current frame. The headers area and the frame column are always visible, even when scrolling the Xsheet area; in this way it's easier to understand how the scene is built.

Frames are rendered reading images from left to right in each cell row.

See  :ref:`Working in Xsheet <working_in_xsheet>`  .


.. _timeline:

Timeline
''''''''

|UI_timeline|

The timeline allows you to manage the scene content, in the same manner as the Xsheet. It is organized in horizontal layers, and layers are divided into cells, representing the content of that layer in that particular frame. In the layers you can load animation levels, clips, images, audio files or other timelines. 

At the leftmost part each layer has its own header containing information about its content. At the top part of the timeline there is a time ruler that displays the frame number, with a cursor placed on the current frame. The headers area and the time ruler are always visible, even when scrolling the timeline area; in this way it's easier to understand how the scene is built.

Frames are rendered reading images from bottom to top in each cell column.

See  :ref:`Working in Xsheet <working_in_xsheet>`  .


.. _history:

History
'''''''

|UI_history|

The history panel, lets you check and undo/redo the history of the latest actions performed in the current Tahoma2D scene.

See  :ref:`Assigning Memory for the Undo Operation <assigning_memory_for_the_undo_operations>`  .


.. _record_audio:

Record Audio
''''''''''''

|UI_recordaudio|

The record audio panel, lets you record a live audio source, listen to it, and insert it into a new audio column of the Xsheet.
The insertion point will be located at the right of the selected cell column, and starting at the selected cell frame.

.. note:: Currently, this panel cannot be docked to form part of a room, like the other ones in the Panels menu. Instead it must be opened as a floating panel, when needed.


.. _customizing_the_interface_appearance:

Customizing the Interface Appearance
------------------------------------
The appearance of the Tahoma2D interface can be customized to suit any production need by choosing a specific language and interface theme.

Tahoma2D allows users to choose a specific language for the software interface, including menus, commands, tooltips, and on-screen messages. Currently available languages are: English, German, Spanish, French, Italian, Czech, Russian, Chinese, Japanese and Korean.

There are also several included themes to choose from: Dark, Darker, Light, Medium and Neutral.

.. figure:: ./_static/UI/themes.png

   The Tahoma2D interface theme set to Dark and to Light.

The interface themes are defined by means of a QSS file, whose concepts, terminology, and syntax are inspired by CSS files (HTML Cascading Style Sheets). The QSS files also refers to a set of PNG images that are used to create interface widgets. 

These files are stored in a folder named as the QSS file, and located in the ``C:\Tahoma stuff\config\qss``  folder on Windows and ``Tahoma stuff\config\qss``  folder on Macintosh. 

.. note:: The QSS file for Macintosh is named with the _mac suffix.

The QSS file can be edited with any text editor software, e.g. Notepad or TextEdit; the PNG images with any image editor software. Editing the QSS file requires some skill in CSS language, but some changes like colors of panel elements, can be easily done by expressing them with red, green and blue values.

.. note:: The QSS files defining the colors and the images used in the Tahoma2D interface have to be written according to a specific syntax, otherwise Tahoma2D interface will not be displayed properly. If you decide to edit a QSS file, make a backup copy first in case you need to revert the file to the original version.

.. tip:: **To choose the interface language:**

    1. Choose File  →  Preferences  →  Interface.

    2. In the Language* option menu choose the language you want to use in the interface.

    3. Restart Tahoma2D to have the interface in the selected language.

.. tip:: **To choose the interface theme:**

    1. Choose File  →  Preferences  →  Interface.

    2. In the Theme option menu choose the style to be applied to the interface.

.. tip:: **To create a new theme:**

    1. Navigate to ``C:\Tahoma stuff\config\qss``  folder on Windows and ``Tahoma stuff\config\qss``  folder on Macintosh.

    2. Duplicate one of the already existing style folder.

    3. Rename the folder and the QSS files inside it with the name you want to assign to the style.

    4. Edit the QSS file and the PNG images contained in the new folder.

.. note:: The new style will be available in the Preferences dialog the next time you run Tahoma2D.

.. tip:: **To edit style QSS file:**

    Open and edit with a text editor software (e.g. Notepad or TextEdit) the QSS files available in the style folder.

.. tip:: **To edit style images:**

    Open and edit with an image editor software the PNG files available in the style folder.



.. |UI_1| image:: ./_static/UI/interface.png
.. |UI_lock| image:: ./_static/UI/room_editing.png
.. |UI_rooms| image:: ./_static/UI/room_menu.png
.. |UI_batch| image:: ./_static/UI/UI_batch.png
.. |UI_cleanup| image:: ./_static/UI/UI_cleanup.png
.. |UI_colormodel| image:: ./_static/UI/UI_colormodel.png
.. |UI_filebrowser| image:: ./_static/UI/UI_filebrowser.png
.. |UI_flipbook| image:: ./_static/UI/UI_flipbook.png
.. |UI_functioneditor| image:: ./_static/UI/UI_functioneditor.png
.. |UI_levelstrip| image:: ./_static/UI/UI_levelstrip.png
.. |UI_palette| image:: ./_static/UI/UI_palette.png
.. |UI_scenecast| image:: ./_static/UI/UI_scenecast.png
.. |UI_schematic| image:: ./_static/UI/UI_schematic.png
.. |UI_styleeditor| image:: ./_static/UI/UI_styleeditor.png
.. |UI_studiopalette| image:: ./_static/UI/UI_studiopalette.png
.. |UI_tasks| image:: ./_static/UI/UI_tasks.png
.. |UI_messagecenter| image:: ./_static/UI/UI_messagecenter.png
.. |UI_toolbar| image:: ./_static/UI/UI_toolbar.png
.. |UI_commandbar| image:: ./_static/UI/UI_commandbar.png
.. |UI_tooloptionsbar| image:: ./_static/UI/UI_tooloptionsbar.png
.. |UI_commandbar_window| image:: ./_static/UI/UI_commandbar_window.png
.. |UI_viewer| image:: ./_static/UI/UI_viewer.png
.. |UI_comboviewer| image:: ./_static/UI/UI_comboviewer.png
.. |UI_xsheet| image:: ./_static/UI/UI_xsheet.png
.. |UI_timeline| image:: ./_static/UI/UI_timeline.png
.. |UI_history| image:: ./_static/UI/UI_history.png
.. |UI_recordaudio| image:: ./_static/UI/UI_recordaudio.png
.. |animate| image:: ./_static/UI/animate.png
.. |bender| image:: ./_static/UI/bender.png
.. |brush| image:: ./_static/UI/brush.png
.. |cpe| image:: ./_static/UI/cpe.png
.. |cutter| image:: ./_static/UI/cutter.png
.. |eraser| image:: ./_static/UI/eraser.png
.. |fill| image:: ./_static/UI/fill.png
.. |geometric| image:: ./_static/UI/geometric.png
.. |hand| image:: ./_static/UI/hand.png
.. |hook| image:: ./_static/UI/hook.png
.. |iron| image:: ./_static/UI/iron.png
.. |magnet| image:: ./_static/UI/magnet.png
.. |paint_brush| image:: ./_static/UI/paint_brush.png
.. |pinch| image:: ./_static/UI/pinch.png
.. |plastic| image:: ./_static/UI/plastic.png
.. |pump| image:: ./_static/UI/pump.png
.. |RGB_picker| image:: ./_static/UI/RGB_picker.png
.. |rotate| image:: ./_static/UI/rotate.png
.. |selection| image:: ./_static/UI/selection.png
.. |skeleton| image:: ./_static/UI/skeleton.png
.. |style_picker| image:: ./_static/UI/style_picker.png
.. |tape| image:: ./_static/UI/tape.png
.. |tracker| image:: ./_static/UI/tracker.png
.. |type| image:: ./_static/UI/type.png
.. |zoom| image:: ./_static/UI/zoom.png