Skip to content

plugin

Loader

Bases: LoaderPlugin

Source code in client/ayon_tvpaint/api/plugin.py
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
class Loader(LoaderPlugin):
    hosts = ["tvpaint"]
    settings_category = "tvpaint"

    @staticmethod
    def get_members_from_container(container):
        if "members" not in container and "objectName" in container:
            # Backwards compatibility
            layer_ids_str = container.get("objectName")
            return [
                int(layer_id) for layer_id in layer_ids_str.split("|")
            ]
        return container["members"]

    def get_unique_layer_name(self, namespace, name):
        """Layer name with counter as suffix.

        Find higher 3 digit suffix from all layer names in scene matching regex
        `{namespace}_{name}_{suffix}`. Higher 3 digit suffix is used
        as base for next number if scene does not contain layer matching regex
        `0` is used ase base.

        Args:
            namespace (str): Usually folder name.
            name (str): Name of loaded product.

        Returns:
            str: `{namespace}_{name}_{higher suffix + 1}`
        """
        layer_name_base = "{}_{}".format(namespace, name)

        counter_regex = re.compile(r"_(\d{3})$")

        higher_counter = 0
        for layer in get_layers_data():
            layer_name = layer["name"]
            if not layer_name.startswith(layer_name_base):
                continue
            number_subpart = layer_name[len(layer_name_base):]
            groups = counter_regex.findall(number_subpart)
            if len(groups) != 1:
                continue

            counter = int(groups[0])
            if counter > higher_counter:
                higher_counter = counter
                continue

        return "{}_{:0>3d}".format(layer_name_base, higher_counter + 1)

get_unique_layer_name(namespace, name)

Layer name with counter as suffix.

Find higher 3 digit suffix from all layer names in scene matching regex {namespace}_{name}_{suffix}. Higher 3 digit suffix is used as base for next number if scene does not contain layer matching regex 0 is used ase base.

Parameters:

Name Type Description Default
namespace str

Usually folder name.

required
name str

Name of loaded product.

required

Returns:

Name Type Description
str

{namespace}_{name}_{higher suffix + 1}

Source code in client/ayon_tvpaint/api/plugin.py
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
def get_unique_layer_name(self, namespace, name):
    """Layer name with counter as suffix.

    Find higher 3 digit suffix from all layer names in scene matching regex
    `{namespace}_{name}_{suffix}`. Higher 3 digit suffix is used
    as base for next number if scene does not contain layer matching regex
    `0` is used ase base.

    Args:
        namespace (str): Usually folder name.
        name (str): Name of loaded product.

    Returns:
        str: `{namespace}_{name}_{higher suffix + 1}`
    """
    layer_name_base = "{}_{}".format(namespace, name)

    counter_regex = re.compile(r"_(\d{3})$")

    higher_counter = 0
    for layer in get_layers_data():
        layer_name = layer["name"]
        if not layer_name.startswith(layer_name_base):
            continue
        number_subpart = layer_name[len(layer_name_base):]
        groups = counter_regex.findall(number_subpart)
        if len(groups) != 1:
            continue

        counter = int(groups[0])
        if counter > higher_counter:
            higher_counter = counter
            continue

    return "{}_{:0>3d}".format(layer_name_base, higher_counter + 1)