load_backdrop

class LoadBackdropNodes(load.LoaderPlugin):
    """Loading published .nk files to backdrop nodes"""

    product_base_types = {"*"}
    product_types = product_base_types
    representations = {"*"}
    extensions = {"nk"}

    settings_category = "nuke"

    label = "Import Nuke Nodes"
    order = 0
    icon = "eye"
    color = "white"
    node_color = "0x7533c1ff"
    remove_nodes_from_backdrop = False

    def load(self, context, name, namespace, data):
        """
        Loading function to import .nk file into script and wrap
        it on backdrop

        Arguments:
            context (dict): context of version
            name (str): name of the version
            namespace (str): namespace name
            data (dict): compulsory attribute > not used

        Returns:
            nuke node: containerised nuke node object
        """

        # get main variables
        namespace = namespace or context["folder"]["name"]
        version_entity = context["version"]

        version_attributes = version_entity["attrib"]
        colorspace = version_attributes.get("colorSpace")

        object_name = "{}_{}".format(name, namespace)

        # prepare data for imprinting
        data_imprint = {
            "version": version_entity["version"],
            "colorspaceInput": colorspace
        }

        # add attributes from the version to imprint to metadata knob
        for k in ["source", "fps"]:
            data_imprint[k] = version_attributes[k]

        # getting file path
        file = self.filepath_from_context(context).replace("\\", "/")

        # adding nodes to node graph
        # just in case we are in group lets jump out of it
        nuke.endGroup()

        # Get mouse position
        n = nuke.createNode("NoOp")
        xcursor, ycursor = (n.xpos(), n.ypos())
        reset_selection()
        nuke.delete(n)

        bdn_frame = 50

        with maintained_selection():

            # add group from nk
            nuke.nodePaste(file)

            # get all pasted nodes
            new_nodes = list()
            nodes = nuke.selectedNodes()

            # get pointer position in DAG
            xpointer, ypointer = find_free_space_to_paste_nodes(
                nodes, direction="right", offset=200 + bdn_frame
            )

            # reset position to all nodes and replace inputs and output
            for n in nodes:
                reset_selection()
                xpos = (n.xpos() - xcursor) + xpointer
                ypos = (n.ypos() - ycursor) + ypointer
                n.setXYpos(xpos, ypos)

                # replace Input nodes for dots
                if n.Class() in "Input":
                    dot = nuke.createNode("Dot")
                    new_name = n.name().replace("INP", "DOT")
                    dot.setName(new_name)
                    dot["label"].setValue(new_name)
                    dot.setXYpos(xpos, ypos)
                    new_nodes.append(dot)

                    # rewire
                    dep = n.dependent()
                    for d in dep:
                        index = next((i for i, dpcy in enumerate(
                                      d.dependencies())
                                      if n is dpcy), 0)
                        d.setInput(index, dot)

                    # remove Input node
                    reset_selection()
                    nuke.delete(n)
                    continue

                # replace Input nodes for dots
                elif n.Class() in "Output":
                    dot = nuke.createNode("Dot")
                    new_name = n.name() + "_DOT"
                    dot.setName(new_name)
                    dot["label"].setValue(new_name)
                    dot.setXYpos(xpos, ypos)
                    new_nodes.append(dot)

                    # rewire
                    dep = next((d for d in n.dependencies()), None)
                    if dep:
                        dot.setInput(0, dep)

                    # remove Input node
                    reset_selection()
                    nuke.delete(n)
                    continue
                else:
                    new_nodes.append(n)

            # reselect nodes with new Dot instead of Inputs and Output
            reset_selection()
            select_nodes(new_nodes)
            # place on backdrop
            bdn = self.set_autobackdrop(xpos, ypos, object_name)
            return containerise(
                node=bdn,
                name=name,
                namespace=namespace,
                context=context,
                loader=self.__class__.__name__,
                data=data_imprint)

    def update(self, container, context):
        """Update the Loader's path

        Nuke automatically tries to reset some variables when changing
        the loader's path to a new file. These automatic changes are to its
        inputs:

        """

        # get main variables
        # Get version from io
        project_name = context["project"]["name"]
        version_entity = context["version"]
        repre_entity = context["representation"]

        # get corresponding node
        GN = container["node"]

        file = self.filepath_from_context(context).replace("\\", "/")

        name = container["name"]
        namespace = container["namespace"]
        object_name = "{}_{}".format(name, namespace)

        version_attributes = version_entity["attrib"]
        colorspace = version_attributes.get("colorSpace")

        data_imprint = {
            "representation": repre_entity["id"],
            "version": version_entity["version"],
            "colorspaceInput": colorspace,
        }

        for k in ["source", "fps"]:
            data_imprint[k] = version_attributes[k]

        # adding nodes to node graph
        # just in case we are in group lets jump out of it
        nuke.endGroup()

        xpos = GN.xpos()
        ypos = GN.ypos()
        avalon_data = get_avalon_knob_data(GN)

        # Preserve external connections (to/from outside the backdrop)
        backdrop_nodes = GN.getNodes()
        with restore_node_connections(backdrop_nodes):
            for node in backdrop_nodes:
                # Delete old backdrop nodes
                nuke.delete(node)
            nuke.delete(GN)

            with maintained_selection():
                # add group from nk
                nuke.nodePaste(file)
                # create new backdrop so that the nodes can be
                # filled within it
                GN = self.set_autobackdrop(xpos, ypos, object_name)
                set_avalon_knob_data(GN, avalon_data)

        # get all versions in list
        last_version_entity = ayon_api.get_last_version_by_product_id(
            project_name, version_entity["productId"], fields={"id"}
        )

        # change color of node
        if version_entity["id"] == last_version_entity["id"]:
            color_value = self.node_color
        else:
            color_value = "0xd88467ff"
        GN["tile_color"].setValue(int(color_value, 16))

        self.log.info(
            "updated to version: {}".format(version_entity["version"])
        )

        return update_container(GN, data_imprint)

    def switch(self, container, context):
        self.update(container, context)

    def remove(self, container):
        node = container["node"]
        with viewer_update_and_undo_stop():
            if self.remove_nodes_from_backdrop:
                for child_node in node.getNodes():
                    nuke.delete(child_node)
            nuke.delete(node)

    def set_autobackdrop(self, xpos, ypos, object_name, bdn_frame=50):
        """Set auto backdrop around selected nodes

        Args:
            xpos (int): x position
            ypos (int): y position
            object_name (str): name of the object
            bdn_frame (int, optional): frame size around the backdrop. Defaults to 50.

        Returns:
            nuke.BackdropNode: the created backdrop node
        """
        # place on backdrop
        bdn = nukescripts.autoBackdrop()

        # add frame offset
        xpos = bdn.xpos() - bdn_frame
        ypos = bdn.ypos() - bdn_frame
        bdwidth = bdn["bdwidth"].value() + (bdn_frame*2)
        bdheight = bdn["bdheight"].value() + (bdn_frame*2)

        bdn["xpos"].setValue(xpos)
        bdn["ypos"].setValue(ypos)
        bdn["bdwidth"].setValue(bdwidth)
        bdn["bdheight"].setValue(bdheight)

        bdn["name"].setValue(object_name)
        bdn["label"].setValue("Version tracked frame: \n`{}`\n\nPLEASE DO NOT REMOVE OR MOVE \nANYTHING FROM THIS FRAME!".format(object_name))
        bdn["note_font_size"].setValue(20)

        return bdn