tik_manager4.dcc.gaffer.main
============================

.. py:module:: tik_manager4.dcc.gaffer.main

.. autoapi-nested-parse::

   Main module for Gaffer integration.



Attributes
----------

.. autoapisummary::

   tik_manager4.dcc.gaffer.main.LOG


Classes
-------

.. autoapisummary::

   tik_manager4.dcc.gaffer.main.Dcc


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

.. py:class:: Dcc

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


   Gaffer DCC class.


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

      Generate a thumbnail for the current scene.



   .. py:method:: get_current_frame()

      Get the current frame.



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


      Get the version of the DCC.



   .. py:method:: get_main_window()

      Get the main window of the DCC.



   .. py:method:: get_ranges()

      Get the viewport ranges.



   .. py:method:: get_scene_file()

      Get the current scene file path.



   .. py:method:: get_scene_fps()

      Get the FPS of the scene.



   .. py:method:: is_modified()

      Check if the current scene is modified.



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

      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)

      Save the current scene as the given file path.



   .. py:method:: save_prompt()

      Pop up the save prompt.



   .. py:method:: save_scene()

      Save the current scene.



   .. py:method:: set_project(file_path)

      Set the project file path and name.



   .. py:method:: set_ranges(range_list)

      Set the viewport ranges.



   .. py:method:: set_scene_fps(fps_value)

      Set the FPS of the scene.



   .. py:attribute:: extensions


   .. py:attribute:: extracts


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



   .. py:attribute:: ingests


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



   .. py:attribute:: preview_enabled
      :value: False



   .. py:attribute:: validations


.. py:data:: LOG