Breakdown2 API Reference

Overview

tk-multi-breakdown2 (Breakdown2) is a customizable Toolkit App that allows studios to manage the behaviour when referencing PublishedFiles within a DCC Engine. It is meant to be a replacement for the original tk-multi-breakdown Application.

Improvements beyond the original Breakdown App

Important

We now use Flow Production Tracking instead of the filesystem to determine the versions of PublishedFiles available.

• Ability to manage references in multiple Flow Production Tracking Projects

• Ability to override to a version of a PublishedFile that is not the latest

• Get version history file information

• Multiple configurable and scalable viewing styles available

Default configuration behaviour

Please see the Toolkit Engine Notes section to see the default hooks provided.

Customizations

Please read the Breakdown Hooks section of this documentation.

• Breakdown API
  • BreakdownManager
  • FileItem
• Breakdown Hooks
  • hook_scene_operations:
  • hook_get_published_files:
  • hook_ui_config:
  • hook_ui_config_advanced:
• Toolkit Engine Notes
  • Alias (tk-alias)
  • Houdini (tk-houdini)
  • Mari (tk-mari)
  • Maya (tk-maya)
  • Nuke & Nuke Studio (tk-nuke & tk-nukestudio)
  • VRED (tk-vred)