tik_manager4.objects.preview
Preview Module.
Attributes
Classes
Preview class. |
|
Data class to hold the preview context. |
Module Contents
- class Preview(preview_context, database_object, settings=None, message_callback=None, feedback=None)
Preview class.
- delete_file(path_obj)
Check if the file path is writable.
- generate(show_after=True)
Generate the preview.
- register_data(preview_data)
Register the preview data to the database object.
- resolve_preview_name()
Resolve the preview name.
- Returns:
tuple: The nice name and the full name tags.
- set_feedback(feedback)
Set the feedback handler.
- Args:
feedback (handler): The feedback handler.
- set_message_callback(callback)
Set the message callback function.
- Args:
callback (function): The message callback function.
- property settings
- Preview settings.
- class PreviewContext(enabled=True, camera=None, label=None, resolution=None, frame_range=None, version_number=None)
Data class to hold the preview context.
- static get_default_camera(cameras)
Convenience function to get the default camera with priority.
- set_camera(value)
Set the camera.
- Args:
value (str): The camera name.
- set_enabled(value)
Set the enabled state.
- Args:
value (bool): The enabled state.
- set_frame_range(value)
Set the frame range.
- Args:
value (list, tuple): The frame range.
- set_label(value)
Set the label.
- Args:
value (str): The label.
- set_resolution(value)
Set the resolution.
- Args:
value (list, tuple): The resolution.
- set_version_number(value)
Set the version number.
- Args:
value (int): The version number.
- property camera
- Preview context camera.
- property enabled
- Preview context enabled.
- property frame_range
- Preview context frame range.
- property label
- Preview context label.
- property resolution
- Preview context resolution.
- property version_number
- Preview context version number.
- LOG