tik_manager4.objects.preview
============================

.. py:module:: tik_manager4.objects.preview

.. autoapi-nested-parse::

   Preview Module.



Attributes
----------

.. autoapisummary::

   tik_manager4.objects.preview.LOG


Classes
-------

.. autoapisummary::

   tik_manager4.objects.preview.Preview
   tik_manager4.objects.preview.PreviewContext


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

.. py:class:: Preview(preview_context, database_object, settings=None, message_callback=None, feedback=None)

   Preview class.


   .. py:method:: delete_file(path_obj)

      Check if the file path is writable.



   .. py:method:: generate(show_after=True)

      Generate the preview.



   .. py:method:: register_data(preview_data)

      Register the preview data to the database object.



   .. py:method:: resolve_preview_name()

      Resolve the preview name.

      Returns:
          tuple: The nice name and the full name tags.



   .. py:method:: set_feedback(feedback)

      Set the feedback handler.

      Args:
          feedback (handler): The feedback handler.



   .. py:method:: set_message_callback(callback)

      Set the message callback function.

      Args:
          callback (function): The message callback function.



   .. py:property:: settings
      Preview settings.



.. py:class:: PreviewContext(enabled=True, camera=None, label=None, resolution=None, frame_range=None, version_number=None)

   Data class to hold the preview context.


   .. py:method:: get_default_camera(cameras)
      :staticmethod:


      Convenience function to get the default camera with priority.



   .. py:method:: set_camera(value)

      Set the camera.

      Args:
          value (str): The camera name.



   .. py:method:: set_enabled(value)

      Set the enabled state.

      Args:
          value (bool): The enabled state.



   .. py:method:: set_frame_range(value)

      Set the frame range.

      Args:
          value (list, tuple): The frame range.



   .. py:method:: set_label(value)

      Set the label.

      Args:
          value (str): The label.



   .. py:method:: set_resolution(value)

      Set the resolution.

      Args:
          value (list, tuple): The resolution.



   .. py:method:: set_version_number(value)

      Set the version number.

      Args:
          value (int): The version number.



   .. py:property:: camera
      Preview context camera.



   .. py:property:: enabled
      Preview context enabled.



   .. py:property:: frame_range
      Preview context frame range.



   .. py:property:: label
      Preview context label.



   .. py:property:: resolution
      Preview context resolution.



   .. py:property:: version_number
      Preview context version number.



.. py:data:: LOG