Skip to content

load_ociolook

LoadOcioLookNodes

Bases: LoaderPlugin

Loading Ocio look to the nuke.Node graph

Source code in client/ayon_nuke/plugins/load/load_ociolook.py
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
class LoadOcioLookNodes(load.LoaderPlugin):
    """Loading Ocio look to the nuke.Node graph"""

    product_types = {"ociolook"}
    representations = {"*"}
    extensions = {"json"}

    settings_category = "nuke"

    label = "Load OcioLook [nodes]"
    order = 0
    icon = "cc"
    color = "white"
    ignore_attr = ["useLifetime"]

    # plugin attributes
    current_node_color = "0x4ecd91ff"
    old_node_color = "0xd88467ff"

    # json file variables
    schema_version = 1

    def load(self, context, name, namespace, data):
        """
        Loading function to get the soft effects to particular read node

        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: containerized nuke.Node object
        """
        namespace = namespace or context["folder"]["name"]
        suffix = secrets.token_hex(nbytes=4)
        node_name = "{}_{}_{}".format(
            name, namespace, suffix)

        # getting file path
        filepath = self.filepath_from_context(context)

        json_f = self._load_json_data(filepath)

        group_node = self._create_group_node(
            filepath, json_f["data"])
        # renaming group node
        group_node["name"].setValue(node_name)

        self._node_version_color(
            context["project"]["name"],
            context["version"],
            group_node
        )

        self.log.info(
            "Loaded lut setup: `{}`".format(group_node["name"].value()))

        return containerise(
            node=group_node,
            name=name,
            namespace=namespace,
            context=context,
            loader=self.__class__.__name__
        )

    def _create_group_node(
        self,
        filepath,
        data,
        group_node=None
    ):
        """Creates group node with all the nodes inside.

        Creating mainly `OCIOFileTransform` nodes with `OCIOColorSpace` nodes
        in between - in case those are needed.

        Arguments:
            filepath (str): path to json file
            data (dict): data from json file
            group_node (Optional[nuke.Node]): group node or None

        Returns:
            nuke.Node: group node with all the nodes inside
        """
        # get corresponding node

        root_working_colorspace = nuke.root()["workingSpaceLUT"].value()

        dir_path = os.path.dirname(filepath)
        all_files = os.listdir(dir_path)

        ocio_working_colorspace = _colorspace_name_by_type(
            data["ocioLookWorkingSpace"])

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

        input_node = None
        output_node = None
        if group_node:
            # remove all nodes between Input and Output nodes
            for node in group_node.nodes():
                if node.Class() not in ["Input", "Output"]:
                    nuke.delete(node)
                elif node.Class() == "Input":
                    input_node = node
                elif node.Class() == "Output":
                    output_node = node
        else:
            group_node = nuke.createNode(
                "Group",
                inpanel=False
            )

        # adding content to the group node
        with group_node:
            pre_colorspace = root_working_colorspace

            # reusing input node if it exists during update
            if input_node:
                pre_node = input_node
            else:
                pre_node = nuke.createNode("Input")
                pre_node["name"].setValue("rgb")

            # Compare script working colorspace with ocio working colorspace
            # found in json file and convert to json's if needed
            if pre_colorspace != ocio_working_colorspace:
                pre_node = _add_ocio_colorspace_node(
                    pre_node,
                    pre_colorspace,
                    ocio_working_colorspace
                )
                pre_colorspace = ocio_working_colorspace

            for ocio_item in data["ocioLookItems"]:
                input_space = _colorspace_name_by_type(
                    ocio_item["input_colorspace"])
                output_space = _colorspace_name_by_type(
                    ocio_item["output_colorspace"])

                # making sure we are set to correct colorspace for otio item
                if pre_colorspace != input_space:
                    pre_node = _add_ocio_colorspace_node(
                        pre_node,
                        pre_colorspace,
                        input_space
                    )

                node = nuke.createNode("OCIOFileTransform")

                # file path from lut representation
                extension = ocio_item["ext"]
                item_name = ocio_item["name"]
                lut_suffix = ocio_item.get("lut_suffix", "")

                item_lut_file = next(
                    (
                        file for file in all_files
                        if file.endswith(extension)
                        and os.path.basename(file).endswith(lut_suffix)
                    ),
                    None
                )
                if not item_lut_file:
                    raise ValueError(
                        "File with extension '{}' not "
                        "found in directory".format(extension)
                    )

                item_lut_path = os.path.join(
                    dir_path, item_lut_file).replace("\\", "/")
                node["file"].setValue(item_lut_path)
                node["name"].setValue(item_name)
                if ocio_item["direction"] == "inverse":
                    node["invert"].setValue(True)
                node["interpolation"].setValue(ocio_item["interpolation"])
                node["working_space"].setValue(input_space)

                pre_node.autoplace()
                node.setInput(0, pre_node)
                node.autoplace()
                # pass output space into pre_colorspace for next iteration
                # or for output node comparison
                pre_colorspace = output_space
                pre_node = node

            # making sure we are back in script working colorspace
            if pre_colorspace != root_working_colorspace:
                pre_node = _add_ocio_colorspace_node(
                    pre_node,
                    pre_colorspace,
                    root_working_colorspace
                )

            # reusing output node if it exists during update
            if not output_node:
                output = nuke.createNode("Output")
            else:
                output = output_node

            output.setInput(0, pre_node)

        return group_node

    def update(self, container, context):
        repre_entity = context["representation"]

        group_node = container["node"]

        filepath = get_representation_path(repre_entity)

        json_f = self._load_json_data(filepath)

        group_node = self._create_group_node(
            filepath,
            json_f["data"],
            group_node
        )

        self._node_version_color(
            context["project"]["name"], context["version"], group_node
        )

        self.log.info("Updated lut setup: `{}`".format(
            group_node["name"].value()))

        return update_container(
            group_node, {"representation": repre_entity["id"]})

    def _load_json_data(self, filepath):
        # getting data from json file with unicode conversion
        with open(filepath, "r") as _file:
            json_f = {self._bytify(key): self._bytify(value)
                      for key, value in json.load(_file).items()}

        # check if the version in json_f is the same as plugin version
        if json_f["version"] != self.schema_version:
            raise KeyError(
                "Version of json file is not the same as plugin version")

        return json_f

    def _bytify(self, input):
        """
        Converts unicode strings to strings
        It goes through all dictionary

        Arguments:
            input (dict/str): input

        Returns:
            dict: with fixed values and keys

        """

        if isinstance(input, dict):
            return {self._bytify(key): self._bytify(value)
                    for key, value in input.items()}
        elif isinstance(input, list):
            return [self._bytify(element) for element in input]
        elif isinstance(input, str):
            return str(input)
        else:
            return input

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

    def remove(self, container):
        node = nuke.toNode(container['objectName'])
        with viewer_update_and_undo_stop():
            nuke.delete(node)

    def _node_version_color(self, project_name, version_entity, node):
        """ Coloring a node by correct color by actual version"""

        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.current_node_color
        else:
            color_value = self.old_node_color
        node["tile_color"].setValue(int(color_value, 16))

load(context, name, namespace, data)

Loading function to get the soft effects to particular read node

Parameters:

Name Type Description Default
context dict

context of version

required
name str

name of the version

required
namespace str

namespace name

required
data dict

compulsory attribute > not used

required

Returns:

Type Description

nuke.Node: containerized nuke.Node object

Source code in client/ayon_nuke/plugins/load/load_ociolook.py
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
def load(self, context, name, namespace, data):
    """
    Loading function to get the soft effects to particular read node

    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: containerized nuke.Node object
    """
    namespace = namespace or context["folder"]["name"]
    suffix = secrets.token_hex(nbytes=4)
    node_name = "{}_{}_{}".format(
        name, namespace, suffix)

    # getting file path
    filepath = self.filepath_from_context(context)

    json_f = self._load_json_data(filepath)

    group_node = self._create_group_node(
        filepath, json_f["data"])
    # renaming group node
    group_node["name"].setValue(node_name)

    self._node_version_color(
        context["project"]["name"],
        context["version"],
        group_node
    )

    self.log.info(
        "Loaded lut setup: `{}`".format(group_node["name"].value()))

    return containerise(
        node=group_node,
        name=name,
        namespace=namespace,
        context=context,
        loader=self.__class__.__name__
    )