tik_manager4.dcc.houdini.main
=============================

.. py:module:: tik_manager4.dcc.houdini.main

.. autoapi-nested-parse::

   Main module for Houdini DCC integration.



Attributes
----------

.. autoapisummary::

   tik_manager4.dcc.houdini.main.LOG


Classes
-------

.. autoapisummary::

   tik_manager4.dcc.houdini.main.Dcc


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

.. py:class:: Dcc

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


   .. 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 Houdini, this is the node path
          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:


      Return the current camera in the scene.
      Returns: (String) Camera name (String), Node path (String)



   .. 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 main window.



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


      Shortcut to get timeline 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 path.



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


      Check if the scene has unsaved changes.



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

      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:: save_as(file_path)
      :staticmethod:


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

      Returns: (String) File path




   .. py:method:: save_prompt()

      Pop up the save prompt.



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


      Save the current scene.



   .. py:method:: set_project(file_path)

      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:


      Shortcut to set the timeline ranges.



   .. py:method:: set_scene_fps(fps_value)

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

      Returns: None




   .. py:attribute:: extensions


   .. py:attribute:: extracts


   .. py:attribute:: formats


   .. py:attribute:: ingests


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



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



   .. py:attribute:: validations


.. py:data:: LOG