tik_manager4.dcc.maya.main
==========================

.. py:module:: tik_manager4.dcc.maya.main

.. autoapi-nested-parse::

   Main module for Maya DCC integration.



Attributes
----------

.. autoapisummary::

   tik_manager4.dcc.maya.main.LOG


Classes
-------

.. autoapisummary::

   tik_manager4.dcc.maya.main.Dcc
   tik_manager4.dcc.maya.main.DockableMainUI
   tik_manager4.dcc.maya.main.RegularMainUI


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

.. py:class:: Dcc

   Bases: :py:obj:`tik_manager4.dcc.main_core.MainCore`


   Maya DCC class.


   .. py:method:: generate_preview(name, folder, camera_code, resolution, range, settings=None)
      :staticmethod:


      Create a preview from the current scene
      Args:
          name: (String) Name of the preview
          folder: (String) Folder to save the preview
          camera_code: (String) Camera code. In Maya, this is the UUID of the camera transform node.
          resolution: (list) Resolution of the preview
          range: (list) Range of the preview
          settings: (dict) Global Settings dictionary



   .. py:method:: generate_thumbnail(file_path, width, height)

      Grabs a thumbnail from the current scene
      Args:
          file_path: (String) File path to save the thumbnail
          width: (Int) Width of the thumbnail
          height: (Int) Height of the thumbnail

      Returns: None




   .. py:method:: get_current_camera()
      :staticmethod:


      Get the current camera and its uuid.



   .. py:method:: get_current_frame()
      :staticmethod:


      Return current frame in timeline.
      If dcc does not have a timeline, returns None.



   .. py:method:: get_dcc_version()
      :staticmethod:


      Return the DCC major version.



   .. py:method:: get_main_window()
      :staticmethod:


      Get the memory adress of the main window to connect Qt dialog to it.
      Returns:
          (long or int) Memory Adress



   .. py:method:: get_ranges()
      :staticmethod:


      Get the viewport ranges.



   .. py:method:: get_scene_cameras()
      :staticmethod:


      Return a dictionary of all the cameras in the scene where key is the camera name and value is the camera uuid.



   .. py:method:: get_scene_file()
      :staticmethod:


      Get the current scene file.



   .. py:method:: get_scene_fps()
      :staticmethod:


      Return the current FPS value set by DCC. None if not supported.



   .. py:method:: is_modified()
      :staticmethod:


      Returns True if the scene has unsaved changes



   .. py:method:: launch(tik_main_object, window_name=None, dont_show=False)

      Launch Tik Main UI with DCC specific way.



   .. py:method:: open(file_path, force=True, **_extra_arguments)
      :staticmethod:


      Open the given file path
      Args:
          file_path: (String) File path to open
          force: (Bool) if true any unsaved changes on current scene will be lost
          **_extra_arguments: Compatibility arguments for other DCCs

      Returns: None



   .. py:method:: save_as(file_path)
      :staticmethod:


      Save the current scene as a new file.
      Args:
          file_path (str): The file path to save the scene to.
      Returns:
          (str) The file path that the scene was saved to.



   .. py:method:: save_prompt()
      :staticmethod:


      Pop up the save prompt.



   .. py:method:: save_scene()
      :staticmethod:


      Saves the current file



   .. py:method:: save_selection(file_path)
      :staticmethod:


      Save the current selection as a new file.



   .. py:method:: set_project(file_path)
      :staticmethod:


      Sets the project to the given path
      Args:
          file_path: (String) Path to the project folder

      Returns: None




   .. py:method:: set_ranges(range_list)
      :staticmethod:


      Set the timeline ranges.



   .. py:method:: set_scene_fps(fps_value)
      :staticmethod:


      Set the FPS value in DCC if supported.
      Args:
          fps_value: (integer) fps value

      Returns: None




   .. py:attribute:: custom_launcher
      :value: True



   .. py:attribute:: extensions


   .. py:attribute:: extracts


   .. py:attribute:: formats
      :value: ['.ma', '.mb']



   .. py:attribute:: ingests


   .. py:attribute:: name
      :value: 'Maya'



   .. py:attribute:: preview_enabled
      :value: True



   .. py:attribute:: save_selection_enabled
      :value: True



   .. py:attribute:: validations


.. py:class:: DockableMainUI(main_object=None, window_name=None, parent=None, **kwargs)

   Bases: :py:obj:`maya.app.general.mayaMixin.MayaQWidgetDockableMixin`, :py:obj:`tik_manager4.ui.main.MainUI`


   Main UI for Tik Manager 4.


   .. py:method:: dockCloseEventTriggered()

      Override the stub function to save the window state.



.. py:class:: RegularMainUI(main_object=None, window_name=None, parent=None, **kwargs)

   Bases: :py:obj:`tik_manager4.ui.main.MainUI`


   Main UI for Tik Manager 4.


.. py:data:: LOG