.. |layers_panel| image:: ../images/panels/layers/layers_panel.png

.. |show_layers| image:: ../images/panels/layers/layers.gif

.. |add_sublayer| image:: ../images/panels/layers/add_layer.png

.. |layer_text| image:: ../images/panels/layers/layer_text.png

Layers
======

The Layer panel allows managing the various `USD Layers <https://openusd.org/release/glossary.html#usdglossary-layer>`_
that make up the overall scene. It provides a visual representation of the layer stack, 
enabling to select the Edit Target, create layers, edit hierarchy, and control the visibility of individual 
layers and sublayers. 

This centralized interface uses a standard USD mechanism including its layering and compositing 
capabilities for non-destructive workflow and scene assembly.

|layers_panel|

Layer Fields
-------------

The Layers panel has the following fields:

.. list-table:: 
    :header-rows: 1
    :widths: 20, 80

    * - Column
      - Description
    * - Name
      - The name of the layer file  
    * - Path
      - The file path location of the layer file
    * - Resolved Path
      - The fully resolved file path after applying any layer path resolution rules.
    * - Muted
      - Indicates if the layer's opinions are included or ignored in the scene composition
    * - Dirty Version
      - Shows if the layer has unsaved edits/changes (is "dirty") compared to the on-disk version
    * - Update Date
      - The date/time when the layer file was last modified
    * - Update User
      - The user that last modified the layer file
    
The columns can be shown or hidden by clicking to the column row with **RMB**
and using the context menu.

Show Menu
---------

The Show Menu provides filtering options to customize which subset of 
layers is displayed in the Layer panel list. This allows users to 
focus on specific layers.

|show_layers|

Layers Panel Actions
--------------------

By double-clicking the layer with **LMB** the user can set it as an **Edit Target**. 

.. note:: 
  This feature only allows for working with SubLayers. Reference/Payload are not supported.

The Layers panel has the following options for 
the selected layers in the **RMB** context menu: 

.. list-table:: 
    :header-rows: 1
    :widths: 20, 80

    * - Option
      - Description
    * - Show Layer Text
      - Displays the full text content of the selected layer file in a separate panel.
    * - Copy Layer Identifier
      - Copies the unique identifier string for the selected layer to the clipboard.
    * - Reload Layer
      - Reloads the selected layer from its file on disk, overwriting any unsaved edits.
    * - Create Sublayer
      - Creates a new empty sublayer inserted above the selected layer in the layer stack.
        This option is also accessible using the |add_sublayer| button in the topbar.  
    * - Create Anonymous Sublayer
      - Creates a new anonymous temporary sublayer above the selected layer.
    * - Add Existing Sublayer
      - Adds an existing sublayer file above the selected layer.
    * - Remove Layer 
      - Removes the selected layer from the layer stack.
    * - Open With
      - Allows opening the layer file with using UsdView, Text Editor, or as a current stage.
    * - Save Layer
      - Saves any unsaved edits/changes made to the selected layer.
    * - Save Layer As
      - Saves the selected layer to a new file location.

.. |reload| image:: ../images/panels/layers/refresh.png
.. |unlock| image:: ../images/panels/layers/unlock.png
.. |save| image:: ../images/panels/layers/save.png

Show Layer Text
================

You can view and modify the contents of a selected layer directly using in-built text editor. 
To access this feature, click a layer with **RMB** and select the **Show Layer Text**.

|layer_text|

The Layer Text window has the following options:

.. list-table:: 
  :header-rows: 1
  :widths: 25, 75

  * - Element
    - Description 
  * - |reload| Reload
    - Reload the layer. All unsaved edits will be erased. 
  * - |unlock| Unlock For Editing
    - Enable editing the text.
  * - |save| Save 
    - Save edits.