##########################################################################################

# init

def init_engine(self):

# note! not using the import as this confuses nuke's calback system

# (several of the key scene callbacks are in the main init file...)

import tk_nuke

self.log_debug("%s: Initializing..." % self)

# now check that there is a location on disk which corresponds to the context

if self.context.project is None:

# must have at least a project in the context to even start!

raise tank.TankError("The nuke engine needs at least a project in the context "

"in order to start! Your context: %s" % self.context)

# make sure we are not running that bloody nuke PLE!

if nuke.env.get("ple") == True:

self.log_error("The Nuke Engine does not work with the Nuke PLE!")

return

# make sure that nuke has a higher version than 6.3v5

# this is because of pyside

nuke_version = (nuke.env.get("NukeVersionMajor"), nuke.env.get("NukeVersionMinor"), nuke.env.get("NukeVersionRelease"))

if nuke_version[0] < 6:

self.log_error("Nuke 6.3v5 is the minimum version supported!")

return

elif (nuke_version[0] == 6

and nuke_version[1] < 3):

self.log_error("Nuke 6.3v5 is the minimum version supported!")

return

elif (nuke_version[0] == 6

and nuke_version[1] == 3

and nuke_version[2] < 5):

self.log_error("Nuke 6.3v5 is the minimum version supported!")

return

# keep track of if a UI exists

self._ui_enabled = nuke.env.get("gui")

# versions > 7.x have not yet been tested so show a message to that effect:

if nuke_version[0] > 7:

# this is an untested version of Nuke

msg = ("The Shotgun Pipeline Toolkit has not yet been fully tested with Nuke %d.%dv%d. "

"You can continue to use the Toolkit but you may experience bugs or "

"instability. Please report any issues you see to toolkitsupport@shotgunsoftware.com"

% (nuke_version[0], nuke_version[1], nuke_version[2]))

# show nuke message if in UI mode, this is the first time the engine has been started

# and the warning dialog isn't overriden by the config:

if (self._ui_enabled

and not "TANK_NUKE_ENGINE_INIT_NAME" in os.environ

and nuke_version[0] >= self.get_setting("compatibility_dialog_min_version", 8)):

nuke.message("Warning - Shotgun Pipeline Toolkit!\n\n%s" % msg)

# and log the warning

self.log_warning(msg)

# now prepare tank so that it will be picked up by any new processes

# created by file->new or file->open.

# Store data needed for bootstrapping Tank in env vars. Used in startup/menu.py

os.environ["TANK_NUKE_ENGINE_INIT_NAME"] = self.instance_name

os.environ["TANK_NUKE_ENGINE_INIT_CONTEXT"] = yaml.dump(self.context)

os.environ["TANK_NUKE_ENGINE_INIT_PROJECT_ROOT"] = self.tank.project_path

# add our startup path to the nuke init path

startup_path = os.path.abspath(os.path.join( os.path.dirname(__file__), "startup"))

tank.util.append_path_to_env_var("NUKE_PATH", startup_path)

# we also need to pass the path to the python folder down to the init script

# because nuke python does not have a __file__ attribute for that file

local_python_path = os.path.abspath(os.path.join( os.path.dirname(__file__), "python"))

os.environ["TANK_NUKE_ENGINE_MOD_PATH"] = local_python_path

# make sure callbacks tracking the context switching are active

tk_nuke.tank_ensure_callbacks_registered()

def post_app_init(self):

"""

Called when all apps have initialized

"""

# render the menu!

if self._ui_enabled:

# note! not using the import as this confuses nuke's calback system

# (several of the key scene callbacks are in the main init file...)

import tk_nuke

menu_name = "Shotgun"

if self.get_setting("use_sgtk_as_menu_name", False):

menu_name = "Sgtk"

self._menu_generator = tk_nuke.MenuGenerator(self, menu_name)

self._menu_generator.create_menu()

self.__setup_favorite_dirs()

# iterate over all apps, if there is a gizmo folder, add it to nuke path

for app in self.apps.values():

# add gizmo to nuke path

app_gizmo_folder = os.path.join(app.disk_location, "gizmos")

if os.path.exists(app_gizmo_folder):

# now translate the path so that nuke is happy on windows

app_gizmo_folder = app_gizmo_folder.replace(os.path.sep, "/")

self.log_debug("Gizmos found - Adding %s to nuke.pluginAddPath() and NUKE_PATH" % app_gizmo_folder)

nuke.pluginAddPath(app_gizmo_folder)

# and also add it to the plugin path - this is so that any

# new processes spawned from this one will have access too.

# (for example if you do file->open or file->new)

tank.util.append_path_to_env_var("NUKE_PATH", app_gizmo_folder)

def destroy_engine(self):

self.log_debug("%s: Destroying..." % self)

if self._ui_enabled:

self._menu_generator.destroy_menu()

@property

def has_ui(self):

"""

Detect and return if nuke is running in batch mode

"""

return self._ui_enabled

def _get_dialog_parent(self):

"""

Return the QWidget parent for all dialogs created through show_dialog & show_modal.

"""

# see https://github.com/shotgunsoftware/tk-nuke/commit/35ca540d152cc5357dc7e347b5efc728a3a89f4a

# for more info. There have been instability issues with nuke 7 causing various crashes, so

# window parenting on Nuke versions above 6 is currently disabled.

if nuke.env.get("NukeVersionMajor") > 6:

return None

return super(NukeEngine, self)._get_dialog_parent()

##########################################################################################

# logging interfaces

def log_debug(self, msg):

if self.get_setting("debug_logging", False):

# print it in the console

msg = "Shotgun Debug: %s" % msg

print msg

def log_info(self, msg):

msg = "Shotgun Info: %s" % msg

# print it in the console

print msg

def log_warning(self, msg):

msg = "Shotgun Warning: %s" % msg

# print it in the nuke error console

nuke.warning(msg)

# also print it in the nuke script console

print msg

def log_error(self, msg):

msg = "Shotgun Error: %s" % msg

# print it in the nuke error console

nuke.error(msg)

# also print it in the nuke script console

print msg

##########################################################################################

# managing favorite dirs

def __setup_favorite_dirs(self):

"""

Sets up nuke shortcut "favorite dirs" that are presented in the left hand side of

nuke common dialogs (open, save)

Nuke currently only writes favorites to disk in ~/.nuke/folders.nk. If you add/remove

one in the UI. Doing them via the api only updates them for the session (Nuke bug #3740).

See http://forums.thefoundry.co.uk/phpBB2/viewtopic.php?t=3481&start=15

"""

engine_root_dir = self.disk_location

tank_logo_small = os.path.abspath(os.path.join(engine_root_dir, "resources", "logo_color_16.png"))

# Ensure old favorites we used to use are removed.

supported_entity_types = ["Shot", "Sequence", "Scene", "Asset", "Project"]

for x in supported_entity_types:

nuke.removeFavoriteDir("Tank Current %s" % x)

nuke.removeFavoriteDir("Tank Current Work")

nuke.removeFavoriteDir("Shotgun Current Project")

nuke.removeFavoriteDir("Shotgun Current Work")

# add favorties for current project root(s)

proj = self.context.project

if proj:

proj_roots = self.tank.roots

for root_name, root_path in proj_roots.items():

dir_name = "Shotgun Current Project"

if len(proj_roots) > 1:

dir_name += " (%s)" % root_name

# remove old directory

nuke.removeFavoriteDir(dir_name)

# add new path

nuke.addFavoriteDir(dir_name,

directory=root_path,

type=(nuke.IMAGE|nuke.SCRIPT|nuke.GEO),

icon=tank_logo_small,

tooltip=root_path)

# add favorites directories from the config

for favorite in self.get_setting("favourite_directories"):

# remove old directory

nuke.removeFavoriteDir(favorite['display_name'])

try:

template = self.get_template_by_name(favorite['template_directory'])

fields = self.context.as_template_fields(template)

path = template.apply_fields(fields)

except Exception, e:

msg = "Error processing template '%s' to add to favorite " \

"directories: %s" % (favorite['template_directory'], e)

self.log_exception(msg)

continue

# add new directory

icon_path = favorite.get('icon')

if not os.path.isfile(icon_path) or not os.path.exists(icon_path):

icon_path = tank_logo_small

nuke.addFavoriteDir(favorite['display_name'],

directory=path,

type=(nuke.IMAGE|nuke.SCRIPT|nuke.GEO),

icon=icon_path,