maya.constructs.panel
=====================

.. py:module:: maya.constructs.panel

.. autoapi-nested-parse::

   Panel construct for managing model panels and camera settings.



Classes
-------

.. autoapisummary::

   maya.constructs.panel.Panel
   maya.constructs.panel.PanelIsolate


Module Contents
---------------

.. py:class:: Panel(camera: Union[str, maya.types.camera.Camera, maya.types.transform.Transform], resolution: Tuple[int, int] = (1920, 1080), inherit: bool = True, title: str = 'Tik Panel')

   Construct for managing a torn-off model panel and associated camera settings.

   This construct creates a floating window with a model panel and manages
   both the panel's display options and the camera's display attributes.
   It supports reverting the camera to its original state upon destruction.


   .. py:method:: activate()

      Make the panel the active panel.



   .. py:method:: close()

      Close the panel window and revert camera settings.



   .. py:method:: fit_view(**kwargs)

      Frame all objects in the panel.



   .. py:method:: get_editor_var(flag: str) -> Any

      Get a modelEditor flag value.

      Args:
          flag: The modelEditor flag name.

      Returns:
          The current value of the flag, or None if panel doesn't exist.



   .. py:method:: revert()

      Revert camera settings to their original state.



   .. py:method:: set_editor_var(flag: str, value: Any)

      Set a modelEditor flag value.

      Args:
          flag: The modelEditor flag name.
          value: The value to set.



   .. py:method:: set_preset(preset: str)

      Apply a predefined preset of settings.

      Args:
          preset: Name of the preset (e.g., 'preview').



   .. py:attribute:: CAMERA_ATTRS
      :value: ['displayFieldChart', 'displayGateMask', 'displayFilmGate', 'displayFilmOrigin',...



   .. py:attribute:: MODEL_EDITOR_FLAGS
      :value: ['activeComponentsXray', 'activeCustomGeometry', 'activeCustomLighSet',...



   .. py:property:: all_objects
      :type: bool


      Whether to display all object types.



   .. py:property:: camera

      The camera associated with this panel.



   .. py:property:: color_management_enabled
      :type: bool


      Whether color management is enabled.



   .. py:property:: display_appearance
      :type: str


      Display appearance mode (e.g., 'wireframe', 'smoothShaded').



   .. py:property:: display_field_chart
      :type: bool


      Whether to display the field chart in the camera view.



   .. py:property:: display_film_gate
      :type: bool


      Whether to display the film gate.



   .. py:property:: display_film_origin
      :type: bool


      Whether to display the film origin.



   .. py:property:: display_film_pivot
      :type: bool


      Whether to display the film pivot.



   .. py:property:: display_gate_mask
      :type: bool


      Whether to display the gate mask.



   .. py:property:: display_resolution
      :type: bool


      Whether to display the resolution gate.



   .. py:property:: display_safe_action
      :type: bool


      Whether to display the safe action area.



   .. py:property:: display_safe_title
      :type: bool


      Whether to display the safe title area.



   .. py:property:: display_textures
      :type: bool


      Whether to display textures.



   .. py:property:: grid
      :type: bool


      Whether to display the grid.



   .. py:property:: hud
      :type: bool


      Whether to display the heads-up display.



   .. py:property:: image_plane
      :type: bool


      Whether to display image planes.



   .. py:property:: isolate

      Return a PanelIsolate helper for managing isolation mode.



   .. py:property:: joints
      :type: bool


      Whether to display joints.



   .. py:property:: locators
      :type: bool


      Whether to display locators.



   .. py:property:: manipulators
      :type: bool


      Whether to display manipulators.



   .. py:property:: name
      :type: Optional[str]


      Return the model panel name.



   .. py:property:: nurbs_curves
      :type: bool


      Whether to display NURBS curves.



   .. py:property:: nurbs_surfaces
      :type: bool


      Whether to display NURBS surfaces.



   .. py:property:: overscan
      :type: float


      The camera overscan value.



   .. py:property:: pivots
      :type: bool


      Whether to display pivots.



   .. py:property:: polymeshes
      :type: bool


      Whether to display polygon meshes.



   .. py:property:: selection_highlighting
      :type: bool


      Whether to highlight selected objects.



   .. py:property:: use_default_material
      :type: bool


      Whether to display objects with default material.



.. py:class:: PanelIsolate(panel)

   Helper class for managing isolation mode in a model panel.


   .. py:method:: add(nodes)

      Add nodes to the isolation set.

      Args:
          nodes: Single node or list of nodes to add to isolation.



   .. py:method:: clear()

      Clear all nodes from the isolation set.



   .. py:method:: enable()

      Enable isolation mode for the panel.



   .. py:method:: remove(nodes)

      Remove nodes from the isolation set.

      Args:
          nodes: Single node or list of nodes to remove from isolation.