Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature: Use cached settings if callback triggered but profile hasn't changed #28

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Feature: Use cached settings if callback triggered but profile hasn't changed #28

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
906471e
added ability to set tank_channel and use_node_name in environment file
Sep 1, 2017
4edda18
fix for exposed write node parameters not being preserved #105729
Sep 15, 2017
33eb44c
Merge branch 'shotgun'
Oct 3, 2017
2491b37
merge from shotgun latest
Oct 3, 2017
2dcc329
#105729: Imported TankWrite nodes are losing settings
Oct 4, 2017
368a934
merge with shotgun/v1.3.1
Jan 26, 2018
34a5615
Feature: Uses cached settings if callback triggered but profile hasn'…
Jan 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 52 additions & 48 deletions python/tk_nuke_writenode/handler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ def set_path_knob(name, value):
set_path_knob("path_filename", file_name)


def __apply_cached_file_format_settings(self, node):
def __apply_cached_file_format_settings(self, node, promoted_knobs=[]):
"""
Apply the file_type and settings that have been cached on the node to the internal
Write node. This mechanism is used when the settings can't be retrieved from the
Expand All @@ -983,7 +983,7 @@ def __apply_cached_file_format_settings(self, node):
% node.name(), e)

# update the node:
self.__populate_format_settings(node, file_type, file_settings)
self.__populate_format_settings(node, file_type, file_settings, False, promoted_knobs)


def __set_profile(self, node, profile_name, reset_all_settings=False):
Expand All @@ -1006,7 +1006,7 @@ def __set_profile(self, node, profile_name, reset_all_settings=False):
# get the profile details:
profile = self._profiles.get(profile_name)
if not profile:
# this shouldn't really every happen!
# this shouldn't really ever happen!
self._app.log_warning("Failed to find a write node profile called '%s' for node '%s'!"
% profile_name, node.name())
# at the very least, try to restore the file format settings from the cached values:
Expand All @@ -1028,6 +1028,11 @@ def __set_profile(self, node, profile_name, reset_all_settings=False):
tile_color = profile["tile_color"]
promote_write_knobs = profile.get("promote_write_knobs", [])

# If the profile hasn't changed, just apply cached file format settings
if profile_name == old_profile_name:
self.__apply_cached_file_format_settings(node, promote_write_knobs)
return

# Make sure any invalid entries are removed from the profile list:
list_profiles = node.knob("tk_profile_list").values()
if list_profiles != self._profile_names:
Expand All @@ -1036,7 +1041,7 @@ def __set_profile(self, node, profile_name, reset_all_settings=False):
# update both the list and the cached value for profile name:
self.__update_knob_value(node, "profile_name", profile_name)
self.__update_knob_value(node, "tk_profile_list", profile_name)

# set the format
self.__populate_format_settings(
node,
Expand All @@ -1051,50 +1056,6 @@ def __set_profile(self, node, profile_name, reset_all_settings=False):
self.__update_knob_value(node, "tk_file_type", file_type)
self.__update_knob_value(node, "tk_file_type_settings", pickle.dumps(file_settings))

# Hide the promoted knobs that might exist from the previously
# active profile.
for promoted_knob in self._promoted_knobs.get(node, []):
promoted_knob.setFlag(nuke.INVISIBLE)

self._promoted_knobs[node] = []
write_node = node.node(TankWriteNodeHandler.WRITE_NODE_NAME)

# We'll use link knobs to tie our top-level knob to the write node's
# knob that we want to promote.
for i, knob_name in enumerate(promote_write_knobs):
target_knob = write_node.knob(knob_name)
if not target_knob:
self._app.log_warning("Knob %s does not exist and will not be promoted." % knob_name)
continue

link_name = "_promoted_" + str(i)

# We have 20 link knobs stashed away to use. If we overflow that
# then we will simply create a new link knob and deal with the
# fact that it will end up in a "User" tab in the UI. The reason
# that we store a gaggle of link knobs on the gizmo is that it's
# the only way to present the promoted knobs in the write node's
# primary tab. Adding knobs after the node exists results in them
# being shoved into a "User" tab all by themselves, which is lame.
if i > 19:
link_knob = nuke.Link_Knob(link_name)
else:
# We have to pull the link knobs from the knobs dict rather than
# by name, otherwise we'll get the link target and not the link
# itself if this is a link that was previously used.
link_knob = node.knobs()[link_name]

link_knob.setLink(target_knob.fullyQualifiedName())
label = target_knob.label() or knob_name
link_knob.setLabel(label)
link_knob.clearFlag(nuke.INVISIBLE)
self._promoted_knobs[node].append(link_knob)

# Adding knobs might have caused us to jump tabs, so we will set
# back to the first tab.
if len(promote_write_knobs) > 19:
node.setTab(0)

# write the template name to the node so that we know it later
self.__update_knob_value(node, "render_template", render_template.name)
self.__update_knob_value(node, "publish_template", publish_template.name)
Expand Down Expand Up @@ -1292,6 +1253,49 @@ def __populate_format_settings(
write_node.readKnobs(r"\n".join(filtered_settings))
self.reset_render_path(node)

# Hide the promoted knobs that might exist from the previously
# active profile.
for promoted_knob in self._promoted_knobs.get(node, []):
promoted_knob.setFlag(nuke.INVISIBLE)

self._promoted_knobs[node] = []

# We'll use link knobs to tie our top-level knob to the write node's
# knob that we want to promote.
for i, knob_name in enumerate(promoted_write_knobs):
target_knob = write_node.knob(knob_name)
if not target_knob:
self._app.log_warning("Knob %s does not exist and will not be promoted." % knob_name)
continue

link_name = "_promoted_" + str(i)

# We have 20 link knobs stashed away to use. If we overflow that
# then we will simply create a new link knob and deal with the
# fact that it will end up in a "User" tab in the UI. The reason
# that we store a gaggle of link knobs on the gizmo is that it's
# the only way to present the promoted knobs in the write node's
# primary tab. Adding knobs after the node exists results in them
# being shoved into a "User" tab all by themselves, which is lame.
if i > 19:
link_knob = nuke.Link_Knob(link_name)
else:
# We have to pull the link knobs from the knobs dict rather than
# by name, otherwise we'll get the link target and not the link
# itself if this is a link that was previously used.
link_knob = node.knobs()[link_name]

link_knob.setLink(target_knob.fullyQualifiedName())
label = target_knob.label() or knob_name
link_knob.setLabel(label)
link_knob.clearFlag(nuke.INVISIBLE)
self._promoted_knobs[node].append(link_knob)

# Adding knobs might have caused us to jump tabs, so we will set
# back to the first tab.
if len(promoted_write_knobs) > 19:
node.setTab(0)

def __set_output(self, node, output_name):
"""
Set the output on the specified node from user interaction.
Expand Down