tik_manager4.dcc.main_core

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

Classes

MainCore

Module Contents

class MainCore
classmethod add_extension(key, value)

Add an extension to the extensions dictionary.

classmethod add_extract(key, value)

Add an extract to the extracts dictionary.

classmethod add_ingest(key, value)

Add an ingest to the ingests dictionary.

classmethod add_validation(key, value)

Add a validation to the validations dictionary.

static collect_classes(file_paths, module_type: object)

Collect classes from modules in the given directory.

collect_common_plugins()

Collect common plugins for the DCC

static generate_preview(name, folder, camera_code, resolution, range, settings=None)

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

static generate_thumbnail(file_path, width, height)

Generate a thumbnail for the given file path.

static get_current_frame()

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

static get_current_selection()

Returns current selection or None if it is not supported

static get_dcc_version()

Returns the current DCC version

static get_main_window()

Returns the main window of the DCC

static get_project()

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

static get_ranges()

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

static get_scene_cameras()

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

static get_scene_file()

Gets the current loaded scene file

static get_scene_fps()

Return the current FPS value set by DCC. None if not supported.

static is_modified()

Returns True if the scene has unsaved changes

static launch()

Open main menu with DCC custom commands.

static 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

static post_publish()

Actions to be done after publishing.

static post_save()

Actions to be done after saving.

static pre_open_issues()

Checks to be done before opening a file.

static pre_publish()

Actions to be done before publishing.

static pre_publish_issues()

Checks to be done before publishing.

static pre_save()

Actions to be done before saving.

static pre_save_issues()

Checks to be done before saving a file.

static save_as(file_path)

Saves the file to the given path Args:

file_path: (String) File path that will be written

static save_prompt()

Pop up the save prompt.

static save_scene()

Saves the current file

static save_selection(file_path)
Abstractmethod:

Saves the current selection to the given path.

Args:

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

static set_project(file_path)

Sets the project path Args:

file_path: (String) File path to set as project

Returns: None

static set_ranges(range_list)

Set the timeline ranges.

Args:

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

Returns: None

static set_scene_fps(fps_value)

Set the FPS value in DCC if supported. Args:

fps_value: (integer) fps value

Returns: None

static test()

Test function

custom_launcher = False
extensions
extracts
formats = []
guard
ingests
name = ''
preview_enabled = True
save_selection_enabled = False
validations