Skip to content

pipeline

Pipeline tools for AYON 3ds max integration.

MaxHost

Bases: HostBase, IWorkfileHost, ILoadHost, IPublishHost

Source code in client/ayon_max/api/pipeline.py
 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
class MaxHost(HostBase, IWorkfileHost, ILoadHost, IPublishHost):

    name = "max"
    menu = None

    def __init__(self):
        super(MaxHost, self).__init__()
        self._op_events = {}
        self._has_been_setup = False

    def get_app_information(self):
        from ayon_core.host import ApplicationInformation

        (
            _rel_number,
            _api_version,
            _rel_rev_number,

            _major_version,
            _update_version,
            _hotfix_number,
            _build_number,

            year_version,
            product_version,
        ) = rt.maxVersion()
        version = f"{year_version}{product_version}"
        return ApplicationInformation(
            app_name="3ds Max",
            app_version=version,
        )

    def install(self):
        pyblish.api.register_host("max")

        pyblish.api.register_plugin_path(PUBLISH_PATH)
        register_loader_plugin_path(LOAD_PATH)
        register_creator_plugin_path(CREATE_PATH)
        register_workfile_build_plugin_path(WORKFILE_BUILD_PATH)

        _set_project()
        _set_autobackup_dir()

        register_event_callback("init", on_init)
        register_event_callback("new", on_new)
        register_event_callback("workfile.open.before", on_before_open)
        register_event_callback("workfile.open.after", on_after_open)
        register_event_callback("before.save", before_save)
        register_event_callback("taskChanged", self.on_task_changed)
        self._has_been_setup = True
        self._register_callbacks()

    def workfile_has_unsaved_changes(self):
        return rt.getSaveRequired()

    def get_workfile_extensions(self):
        return [".max"]

    def save_workfile(self, dst_path=None):
        rt.saveMaxFile(dst_path)
        return dst_path

    def open_workfile(self, filepath):
        rt.checkForSave()
        rt.loadMaxFile(filepath)
        return filepath

    def get_current_workfile(self):
        return os.path.normpath(
            os.path.join(rt.maxFilePath, rt.maxFileName)
        )

    def get_containers(self):
        return ls()

    def _register_callbacks(self):
        rt.callbacks.removeScripts(id=rt.name("AyonCallbacks"))
        rt.callbacks.addScript(
            rt.Name('welcomeScreenDone'),
            self.on_init, id=rt.name("AyonCallbacks")
        )
        rt.callbacks.addScript(
            rt.Name('systemPostNew'),
            _on_scene_new,
            id=rt.name("AyonCallbacks")
        )
        rt.callbacks.addScript(
            rt.Name('filePostSave'),
            _on_scene_save,
            id=rt.name("AyonCallbacks")
        )
        rt.callbacks.addScript(
            rt.Name('filePostOpen'),
            _on_scene_open,
            id=rt.name("AyonCallbacks")
        )
        if lib.get_max_version() < 2026:
            rt.callbacks.addScript(
                rt.Name('postWorkspaceChange'),
                self._deferred_menu_creation,
                id=rt.name("AyonCallbacks"))

        rt.NodeEventCallback(
            nameChanged=lib.update_modifier_node_names)

    def on_init(self):
        if not self.menu:
            self._deferred_menu_creation()
        _on_scene_init()

    def _deferred_menu_creation(self):
        self.log.info("Building menu ...")
        self.menu = AYONMenu()

    @staticmethod
    def create_context_node():
        """Helper for creating context holding node."""

        root_scene = rt.rootScene

        create_attr_script = ("""
attributes "AYONContext"
(
    parameters main rollout:params
    (
        context type: #string
    )

    rollout params "AYON Parameters"
    (
        editText editTextContext "Context" type: #string
    )
)
        """)

        attr = rt.execute(create_attr_script)
        rt.custAttributes.add(root_scene, attr)

        return root_scene.AYONContext.context

    def update_context_data(self, data, changes):
        try:
            _ = rt.rootScene.AYONContext.context
        except AttributeError:
            # context node doesn't exists
            self.create_context_node()

        rt.rootScene.AYONContext.context = json.dumps(data)

    def get_context_data(self):
        try:
            context = rt.rootScene.AYONContext.context
        except AttributeError:
            # context node doesn't exists
            context = self.create_context_node()
        if not context:
            context = "{}"
        return json.loads(context)

    def on_task_changed(self):
        if lib.is_headless():
            return

        ayon_menu = self.menu.menu
        if ayon_menu is not None:
            actions = ayon_menu.actions()
            context_action = actions[0]
            context_label = lib.get_context_label()
            context_action.setText(f"{context_label}")

create_context_node() staticmethod

Helper for creating context holding node.

Source code in client/ayon_max/api/pipeline.py
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
    @staticmethod
    def create_context_node():
        """Helper for creating context holding node."""

        root_scene = rt.rootScene

        create_attr_script = ("""
attributes "AYONContext"
(
    parameters main rollout:params
    (
        context type: #string
    )

    rollout params "AYON Parameters"
    (
        editText editTextContext "Context" type: #string
    )
)
        """)

        attr = rt.execute(create_attr_script)
        rt.custAttributes.add(root_scene, attr)

        return root_scene.AYONContext.context

before_save(event)

Check and set up project before saving workfile

Source code in client/ayon_max/api/pipeline.py
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
def before_save(event):
    """Check and set up project before saving workfile
    """
    max_filename_before: str = rt.maxFileName
    max_filename_after: str = event.get("filename")

    if not max_filename_before:
        # Saving from a new unsaved file, no need to check for changes.
        return

    if max_filename_before != max_filename_after:
        print(f"Detected scene name change from {max_filename_before} to "
              f"{max_filename_after}")
    max_filename_before = os.path.splitext(max_filename_before)[0]
    max_filename_after = os.path.splitext(max_filename_after)[0]
    lib.reset_render_outputs(max_filename_before, max_filename_after)

containerise_texture(name, context, view_node, sme_view_number, namespace=None, loader=None, suffix='_CON')

Containerise texture nodes

Parameters:

Name Type Description Default
name str

name of the container

required
context dict

context

required
view_node

texture node

required
sme_view

target view of slate material editor

required
namespace str

namespace. Defaults to None.

None
loader str

loader. Defaults to None.

None
suffix str

suffix. Defaults to "_CON".

'_CON'

Returns:

Name Type Description
container

The container object holding the texture node metadata.

Source code in client/ayon_max/api/pipeline.py
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
def containerise_texture(name: str, context: dict,
                         view_node, sme_view_number,
                         namespace=None, loader=None,
                         suffix="_CON"):
    """Containerise texture nodes

    Args:
        name (str): name of the container
        context (dict): context
        view_node: texture node
        sme_view: target view of slate material editor
        namespace (str, optional): namespace. Defaults to None.
        loader (str, optional): loader. Defaults to None.
        suffix (str, optional): suffix. Defaults to "_CON".

    Returns:
        container: The container object holding the texture node metadata.
    """
    data = {
        "schema": "ayon:container-3.0",
        "id": AYON_CONTAINER_ID,
        "name": name,
        "namespace": namespace or "",
        "loader": loader,
        "representation": context["representation"]["id"],
        "project_name": context["project"]["name"],
        "view_node": view_node,
        "sme_view_number": sme_view_number,
    }
    container_name = f"{namespace}:{name}{suffix}"
    container = rt.container(name=container_name)
    if not lib.imprint(container_name, data):
        raise RuntimeError(f"imprinting of {container_name} failed.")
    return container

get_containers()

Get all container nodes in the scene.

Returns:

Name Type Description
list List

list of container nodes in the scene

Source code in client/ayon_max/api/pipeline.py
263
264
265
266
267
268
269
270
271
272
273
274
def get_containers() -> List:
    """Get all container nodes in the scene.

    Returns:
        list : list of container nodes in the scene
    """
    return [
        obj for obj in rt.objects
        if rt.getUserProp(obj, "id") in {
            AYON_CONTAINER_ID, AVALON_CONTAINER_ID
        }
    ]

get_previous_loaded_object(container)

Get previous loaded_object through the AYON Data

Parameters:

Name Type Description Default
container str

the container which stores the AYON Data

required

Returns:

Name Type Description
node_list list

list of nodes which are previously loaded

Source code in client/ayon_max/api/pipeline.py
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
def get_previous_loaded_object(container: str):
    """Get previous loaded_object through the AYON Data

    Args:
        container (str): the container which stores the AYON Data

    Returns:
        node_list(list): list of nodes which are previously loaded
    """
    node_list = []
    container_modifier = container.modifiers[0]
    ayon_data = lib.get_ayon_data(container_modifier)
    node_transform_monitor_list = rt.getProperty(ayon_data, "all_handles")
    for node_transform_monitor in node_transform_monitor_list:
        node_list.append(node_transform_monitor.node)
    return node_list

import_custom_attribute_data(container, selections)

Importing the AYON custom parameter built by the creator

Parameters:

Name Type Description Default
container str

target container which adds custom attributes

required
selections list

nodes to be added into

required
Source code in client/ayon_max/api/pipeline.py
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
def import_custom_attribute_data(container: str, selections: list):
    """Importing the AYON custom parameter built by the creator

    Args:
        container (str): target container which adds custom attributes
        selections (list): nodes to be added into
        group in custom attributes
    """
    attrs = load_custom_attribute_data()
    modifier = rt.EmptyModifier()
    rt.addModifier(container, modifier)
    container.modifiers[0].name = "AYON Data"
    rt.custAttributes.add(container.modifiers[0], attrs)
    node_list = []
    sel_list = []
    for i in selections:
        node_ref = rt.NodeTransformMonitor(node=i)
        node_list.append(node_ref)
        sel_list.append(str(i))

    # Setting the property
    rt.setProperty(
        container.modifiers[0].AYONData,
        "all_handles", node_list)
    rt.setProperty(
        container.modifiers[0].AYONData,
        "sel_list", sel_list)

load_custom_attribute_data()

Re-loading the AYON custom parameter built by the creator

Returns:

Name Type Description
attribute

re-loading the custom OP attributes set in Maxscript

Source code in client/ayon_max/api/pipeline.py
419
420
421
422
423
424
425
def load_custom_attribute_data():
    """Re-loading the AYON custom parameter built by the creator

    Returns:
        attribute: re-loading the custom OP attributes set in Maxscript
    """
    return rt.Execute(MS_CUSTOM_ATTRIB)

ls()

Get all AYON containers.

Source code in client/ayon_max/api/pipeline.py
256
257
258
259
260
def ls() -> Generator[dict, None, None]:
    """Get all AYON containers."""
    containers = get_containers()
    for container in sorted(containers, key=attrgetter("name")):
        yield parse_container(container)

on_after_open()

Check and set up unit scale after opening workfile if user enabled.

Source code in client/ayon_max/api/pipeline.py
395
396
397
398
def on_after_open():
    """Check and set up unit scale after opening workfile if user enabled.
    """
    lib.validate_unit_scale()

on_before_open()

Check and set up project before opening workfile

Source code in client/ayon_max/api/pipeline.py
389
390
391
392
def on_before_open():
    """Check and set up project before opening workfile
    """
    _set_project()

parse_container(container)

Return the container node's full container data.

Parameters:

Name Type Description Default
container str

A container node name.

required

Returns:

Name Type Description
dict

The container schema data for this container node.

Source code in client/ayon_max/api/pipeline.py
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
def parse_container(container):
    """Return the container node's full container data.

    Args:
        container (str): A container node name.

    Returns:
        dict: The container schema data for this container node.

    """
    data = lib.read(container)

    # Backwards compatibility pre-schemas for containers
    data["schema"] = data.get("schema", "ayon:container-3.0")

    # Append transient data
    data["objectName"] = container.Name
    return data

remove_container_data(container_node)

Function to remove container data after updating, switching or deleting it.

Parameters:

Name Type Description Default
container_node str

container node

required
Source code in client/ayon_max/api/pipeline.py
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
def remove_container_data(container_node: str):
    """Function to remove container data after updating, switching or deleting it.

    Args:
        container_node (str): container node
    """
    if not rt.isProperty(container_node, "modifiers"):
        rt.Delete(container_node)
        rt.redrawViews()
        return

    container_node_modifier = container_node.modifiers[0]
    if container_node_modifier.name in {"OP Data", "AYON Data"}:
        ayon_data = lib.get_ayon_data(container_node_modifier)
        all_set_members_names = [
            member.node for member in ayon_data.all_handles
        ]
        if not all_set_members_names:
            rt.deleteModifier(container_node, container_node.modifiers[0])
            rt.Delete(container_node)
            rt.redrawViews()
            return
        # clean up the children of alembic dummy objects
        for current_set_member in all_set_members_names:
            shape_list = [
                members for members in current_set_member
                if rt.ClassOf(members) == rt.AlembicObject
                or rt.isValidNode(members)
            ]
            if shape_list:  # noqa
                rt.Delete(shape_list)
            rt.Delete(current_set_member)
        rt.deleteModifier(container_node, container_node.modifiers[0])

    rt.Delete(container_node)
    rt.redrawViews()

update_custom_attribute_data(container, selections)

Updating the AYON custom parameter built by the creator

Parameters:

Name Type Description Default
container str

target container which adds custom attributes

required
selections list

nodes to be added into

required
Source code in client/ayon_max/api/pipeline.py
457
458
459
460
461
462
463
464
465
466
467
def update_custom_attribute_data(container: str, selections: list):
    """Updating the AYON custom parameter built by the creator

    Args:
        container (str): target container which adds custom attributes
        selections (list): nodes to be added into
        group in custom attributes
    """
    if container.modifiers[0].name in {"OP Data", "AYON Data"}:
        rt.deleteModifier(container, container.modifiers[0])
    import_custom_attribute_data(container, selections)