tik_manager4.dcc.main_core
==========================

.. py:module:: tik_manager4.dcc.main_core

.. autoapi-nested-parse::

   Template class for all available DCC commands.
   These commands will be overriden in DCCs.



Classes
-------

.. autoapisummary::

   tik_manager4.dcc.main_core.MainCore


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

.. py:class:: MainCore

   .. py:method:: add_extension(key, value)
      :classmethod:


      Add an extension to the extensions dictionary.



   .. py:method:: add_extract(key, value)
      :classmethod:


      Add an extract to the extracts dictionary.



   .. py:method:: add_ingest(key, value)
      :classmethod:


      Add an ingest to the ingests dictionary.



   .. py:method:: add_validation(key, value)
      :classmethod:


      Add a validation to the validations dictionary.



   .. py:method:: collect_classes(file_paths, module_type: object)
      :staticmethod:


      Collect classes from modules in the given directory.



   .. py:method:: collect_common_plugins()

      Collect common plugins for the DCC



   .. 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)
      :staticmethod:


      Generate a thumbnail for the given file path.



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


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



   .. py:method:: get_current_selection()
      :staticmethod:


      Returns current selection or None if it is not supported



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


      Returns the current DCC version



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


      Returns the main window of the DCC



   .. py:method:: get_project()
      :staticmethod:


      Return currently set project by dcc.
      If dcc does not support project management, return None.



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


      Get the viewport ranges.
      Returns: (list) [<absolute range start>, <user range start>, <user range end>,
      <absolute range end>



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


      Return all the cameras in the scene.
      Returns: (list) List of camera names



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


      Gets the current loaded 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()
      :staticmethod:


      Open main menu with DCC custom commands.



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


      Opens 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:: post_publish()
      :staticmethod:


      Actions to be done after publishing.



   .. py:method:: post_save()
      :staticmethod:


      Actions to be done after saving.



   .. py:method:: pre_open_issues()
      :staticmethod:


      Checks to be done before opening a file.



   .. py:method:: pre_publish()
      :staticmethod:


      Actions to be done before publishing.



   .. py:method:: pre_publish_issues()
      :staticmethod:


      Checks to be done before publishing.



   .. py:method:: pre_save()
      :staticmethod:


      Actions to be done before saving.



   .. py:method:: pre_save_issues()
      :staticmethod:


      Checks to be done before saving a file.



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


      Saves the file to the given path
      Args:
          file_path: (String) File path that will be written



   .. 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:

      :abstractmethod:


      Saves the current selection to the given path.

      Args:
          file_path: (String) File path that will be written.



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


      Sets the project path
      Args:
          file_path: (String) File path to set as project

      Returns: None




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


      Set the timeline ranges.

      Args:
          range_list: list of ranges as [<animation start>, <user min>, <user max>,
          <animation end>]

      Returns: None




   .. 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:method:: test()
      :staticmethod:


      Test function



   .. py:attribute:: custom_launcher
      :value: False



   .. py:attribute:: extensions


   .. py:attribute:: extracts


   .. py:attribute:: formats
      :value: []



   .. py:attribute:: guard


   .. py:attribute:: ingests


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



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



   .. py:attribute:: save_selection_enabled
      :value: False



   .. py:attribute:: validations