Skip to content

load_effects

LoadEffects

Bases: LoaderPlugin

Loading colorspace soft effect exported from nukestudio

Source code in client/ayon_nuke/plugins/load/load_effects.py
 17
 18
 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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
class LoadEffects(load.LoaderPlugin):
    """Loading colorspace soft effect exported from nukestudio"""

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

    settings_category = "nuke"

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

    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: containerised nuke node object
        """
        # get main variables
        version_entity = context["version"]

        version_attributes = version_entity["attrib"]
        first = version_attributes.get("frameStart")
        last = version_attributes.get("frameEnd")
        colorspace = version_attributes.get("colorSpace")

        workfile_first_frame = int(nuke.root()["first_frame"].getValue())
        namespace = namespace or context["folder"]["name"]
        object_name = "{}_{}".format(name, namespace)

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

        # add additional metadata from the version to imprint to Avalon knob
        for k in [
            "frameStart",
            "frameEnd",
            "handleStart",
            "handleEnd",
            "source",
            "fps"
        ]:
            data_imprint[k] = version_attributes[k]

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

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

        # get correct order of nodes by positions on track and subtrack
        nodes_order = self.reorder_nodes(json_f)

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

        GN = nuke.createNode(
            "Group",
            "name {}_1".format(object_name),
            inpanel=False
        )

        # adding content to the group node
        with GN:
            pre_node = nuke.createNode("Input")
            pre_node["name"].setValue("rgb")

            for ef_name, ef_val in nodes_order.items():
                node = nuke.createNode(ef_val["class"])
                for k, v in ef_val["node"].items():
                    if k in self.ignore_attr:
                        continue

                    try:
                        node[k].value()
                    except NameError as e:
                        self.log.warning(e)
                        continue

                    if isinstance(v, list) and len(v) > 4:
                        node[k].setAnimated()
                        for i, value in enumerate(v):
                            if isinstance(value, list):
                                for ci, cv in enumerate(value):
                                    node[k].setValueAt(
                                        cv,
                                        (workfile_first_frame + i),
                                        ci)
                            else:
                                node[k].setValueAt(
                                    value,
                                    (workfile_first_frame + i))
                    else:
                        node[k].setValue(v)
                node.setInput(0, pre_node)
                pre_node = node

            output = nuke.createNode("Output")
            output.setInput(0, pre_node)

        # try to find parent read node
        self.connect_read_node(GN, namespace, json_f["assignTo"])

        GN["tile_color"].setValue(int("0x3469ffff", 16))

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

        return containerise(
            node=GN,
            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 = get_representation_path(repre_entity).replace("\\", "/")

        version_attributes = version_entity["attrib"]
        first = version_attributes.get("frameStart")
        last = version_attributes.get("frameEnd")
        colorspace = version_attributes.get("colorSpace")

        workfile_first_frame = int(nuke.root()["first_frame"].getValue())
        namespace = container["namespace"]

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

        for k in [
            "frameStart",
            "frameEnd",
            "handleStart",
            "handleEnd",
            "source",
            "fps",
        ]:
            data_imprint[k] = version_attributes[k]

        # Update the imprinted representation
        update_container(
            GN,
            data_imprint
        )

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

        # get correct order of nodes by positions on track and subtrack
        nodes_order = self.reorder_nodes(json_f)

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

        # adding content to the group node
        with GN:
            # first remove all nodes
            [nuke.delete(n) for n in nuke.allNodes()]

            # create input node
            pre_node = nuke.createNode("Input")
            pre_node["name"].setValue("rgb")

            for _, ef_val in nodes_order.items():
                node = nuke.createNode(ef_val["class"])
                for k, v in ef_val["node"].items():
                    if k in self.ignore_attr:
                        continue

                    try:
                        node[k].value()
                    except NameError as e:
                        self.log.warning(e)
                        continue

                    if isinstance(v, list) and len(v) > 4:
                        node[k].setAnimated()
                        for i, value in enumerate(v):
                            if isinstance(value, list):
                                for ci, cv in enumerate(value):
                                    node[k].setValueAt(
                                        cv,
                                        (workfile_first_frame + i),
                                        ci)
                            else:
                                node[k].setValueAt(
                                    value,
                                    (workfile_first_frame + i))
                    else:
                        node[k].setValue(v)
                node.setInput(0, pre_node)
                pre_node = node

            # create output node
            output = nuke.createNode("Output")
            output.setInput(0, pre_node)

        # try to find parent read node
        self.connect_read_node(GN, namespace, json_f["assignTo"])

        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 = "0x3469ffff"
        else:
            color_value = "0xd84f20ff"

        GN["tile_color"].setValue(int(color_value, 16))

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

    def connect_read_node(self, group_node, namespace, product_name):
        """
        Finds read node and selects it

        Arguments:
            namespace (str): namespace name

        Returns:
            nuke node: node is selected
            None: if nothing found
        """
        search_name = "{0}_{1}".format(namespace, product_name)

        node = [
            n for n in nuke.allNodes(filter="Read")
            if search_name in n["file"].value()
        ]
        if len(node) > 0:
            rn = node[0]
        else:
            rn = None

        # Parent read node has been found
        # solving connections
        if rn:
            dep_nodes = rn.dependent()

            if len(dep_nodes) > 0:
                for dn in dep_nodes:
                    dn.setInput(0, group_node)

            group_node.setInput(0, rn)
            group_node.autoplace()

    def reorder_nodes(self, data):
        new_order = OrderedDict()
        trackNums = [v["trackIndex"] for k, v in data.items()
                     if isinstance(v, dict)]
        subTrackNums = [v["subTrackIndex"] for k, v in data.items()
                        if isinstance(v, dict)]

        for trackIndex in range(
                min(trackNums), max(trackNums) + 1):
            for subTrackIndex in range(
                    min(subTrackNums), max(subTrackNums) + 1):
                item = self.get_item(data, trackIndex, subTrackIndex)
                if item:
                    new_order.update(item)
        return new_order

    def get_item(self, data, trackIndex, subTrackIndex):
        return {key: val for key, val in data.items()
                if isinstance(val, dict)
                if subTrackIndex == val["subTrackIndex"]
                if trackIndex == val["trackIndex"]}

    def byteify(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.byteify(key): self.byteify(value)
                    for key, value in input.items()}
        elif isinstance(input, list):
            return [self.byteify(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 = container["node"]
        with viewer_update_and_undo_stop():
            nuke.delete(node)

byteify(input)

Converts unicode strings to strings It goes through all dictionary

Parameters:

Name Type Description Default
input dict / str

input

required

Returns:

Name Type Description
dict

with fixed values and keys

Source code in client/ayon_nuke/plugins/load/load_effects.py
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
def byteify(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.byteify(key): self.byteify(value)
                for key, value in input.items()}
    elif isinstance(input, list):
        return [self.byteify(element) for element in input]
    elif isinstance(input, str):
        return str(input)
    else:
        return input

connect_read_node(group_node, namespace, product_name)

Finds read node and selects it

Parameters:

Name Type Description Default
namespace str

namespace name

required

Returns:

Name Type Description

nuke node: node is selected

None

if nothing found

Source code in client/ayon_nuke/plugins/load/load_effects.py
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
def connect_read_node(self, group_node, namespace, product_name):
    """
    Finds read node and selects it

    Arguments:
        namespace (str): namespace name

    Returns:
        nuke node: node is selected
        None: if nothing found
    """
    search_name = "{0}_{1}".format(namespace, product_name)

    node = [
        n for n in nuke.allNodes(filter="Read")
        if search_name in n["file"].value()
    ]
    if len(node) > 0:
        rn = node[0]
    else:
        rn = None

    # Parent read node has been found
    # solving connections
    if rn:
        dep_nodes = rn.dependent()

        if len(dep_nodes) > 0:
            for dn in dep_nodes:
                dn.setInput(0, group_node)

        group_node.setInput(0, rn)
        group_node.autoplace()

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: containerised nuke node object

Source code in client/ayon_nuke/plugins/load/load_effects.py
 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
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: containerised nuke node object
    """
    # get main variables
    version_entity = context["version"]

    version_attributes = version_entity["attrib"]
    first = version_attributes.get("frameStart")
    last = version_attributes.get("frameEnd")
    colorspace = version_attributes.get("colorSpace")

    workfile_first_frame = int(nuke.root()["first_frame"].getValue())
    namespace = namespace or context["folder"]["name"]
    object_name = "{}_{}".format(name, namespace)

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

    # add additional metadata from the version to imprint to Avalon knob
    for k in [
        "frameStart",
        "frameEnd",
        "handleStart",
        "handleEnd",
        "source",
        "fps"
    ]:
        data_imprint[k] = version_attributes[k]

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

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

    # get correct order of nodes by positions on track and subtrack
    nodes_order = self.reorder_nodes(json_f)

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

    GN = nuke.createNode(
        "Group",
        "name {}_1".format(object_name),
        inpanel=False
    )

    # adding content to the group node
    with GN:
        pre_node = nuke.createNode("Input")
        pre_node["name"].setValue("rgb")

        for ef_name, ef_val in nodes_order.items():
            node = nuke.createNode(ef_val["class"])
            for k, v in ef_val["node"].items():
                if k in self.ignore_attr:
                    continue

                try:
                    node[k].value()
                except NameError as e:
                    self.log.warning(e)
                    continue

                if isinstance(v, list) and len(v) > 4:
                    node[k].setAnimated()
                    for i, value in enumerate(v):
                        if isinstance(value, list):
                            for ci, cv in enumerate(value):
                                node[k].setValueAt(
                                    cv,
                                    (workfile_first_frame + i),
                                    ci)
                        else:
                            node[k].setValueAt(
                                value,
                                (workfile_first_frame + i))
                else:
                    node[k].setValue(v)
            node.setInput(0, pre_node)
            pre_node = node

        output = nuke.createNode("Output")
        output.setInput(0, pre_node)

    # try to find parent read node
    self.connect_read_node(GN, namespace, json_f["assignTo"])

    GN["tile_color"].setValue(int("0x3469ffff", 16))

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

    return containerise(
        node=GN,
        name=name,
        namespace=namespace,
        context=context,
        loader=self.__class__.__name__,
        data=data_imprint)

update(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:

Source code in client/ayon_nuke/plugins/load/load_effects.py
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
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 = get_representation_path(repre_entity).replace("\\", "/")

    version_attributes = version_entity["attrib"]
    first = version_attributes.get("frameStart")
    last = version_attributes.get("frameEnd")
    colorspace = version_attributes.get("colorSpace")

    workfile_first_frame = int(nuke.root()["first_frame"].getValue())
    namespace = container["namespace"]

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

    for k in [
        "frameStart",
        "frameEnd",
        "handleStart",
        "handleEnd",
        "source",
        "fps",
    ]:
        data_imprint[k] = version_attributes[k]

    # Update the imprinted representation
    update_container(
        GN,
        data_imprint
    )

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

    # get correct order of nodes by positions on track and subtrack
    nodes_order = self.reorder_nodes(json_f)

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

    # adding content to the group node
    with GN:
        # first remove all nodes
        [nuke.delete(n) for n in nuke.allNodes()]

        # create input node
        pre_node = nuke.createNode("Input")
        pre_node["name"].setValue("rgb")

        for _, ef_val in nodes_order.items():
            node = nuke.createNode(ef_val["class"])
            for k, v in ef_val["node"].items():
                if k in self.ignore_attr:
                    continue

                try:
                    node[k].value()
                except NameError as e:
                    self.log.warning(e)
                    continue

                if isinstance(v, list) and len(v) > 4:
                    node[k].setAnimated()
                    for i, value in enumerate(v):
                        if isinstance(value, list):
                            for ci, cv in enumerate(value):
                                node[k].setValueAt(
                                    cv,
                                    (workfile_first_frame + i),
                                    ci)
                        else:
                            node[k].setValueAt(
                                value,
                                (workfile_first_frame + i))
                else:
                    node[k].setValue(v)
            node.setInput(0, pre_node)
            pre_node = node

        # create output node
        output = nuke.createNode("Output")
        output.setInput(0, pre_node)

    # try to find parent read node
    self.connect_read_node(GN, namespace, json_f["assignTo"])

    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 = "0x3469ffff"
    else:
        color_value = "0xd84f20ff"

    GN["tile_color"].setValue(int(color_value, 16))

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