Custom Actions in loader

Tobias · 19 June 2024 09:46

(How) is it possible to add a custom Action to a DCCs Loader context menu? (Houdini for example)

mustafa_jafar · 19 June 2024 12:21

Hello Tobias,

You can achieve that by implementing a loader plugin.
Here are some examples:

These are some actions. Notice they don’t actually load any thing in the scene but they still inherit plugin.HoudiniLoader

github.com

ynput/ayon-core/blob/506c9975af1237635827fdc45459ab57c4e2fed1/server_addon/houdini/client/ayon_houdini/plugins/load/actions.py

"""A module containing generic loader actions that will display in the Loader.

"""

from ayon_houdini.api import plugin


class SetFrameRangeLoader(plugin.HoudiniLoader):
    """Set frame range excluding pre- and post-handles"""

    product_types = {
        "animation",
        "camera",
        "pointcache",
        "vdbcache",
        "usd",
    }
    representations = {"abc", "vdb", "usd"}

    label = "Set frame range"

This file has been truncated. show original

This loads FBX representations to the scene.

github.com

ynput/ayon-core/blob/506c9975af1237635827fdc45459ab57c4e2fed1/server_addon/houdini/client/ayon_houdini/plugins/load/load_fbx.py

# -*- coding: utf-8 -*-
"""Fbx Loader for houdini. """
from ayon_core.pipeline import get_representation_path
from ayon_houdini.api import (
    pipeline,
    plugin
)


class FbxLoader(plugin.HoudiniLoader):
    """Load fbx files. """

    label = "Load FBX"
    icon = "code-fork"
    color = "orange"

    order = -10

    product_types = {"*"}
    representations = {"*"}

This file has been truncated. show original

Petr_Kalis · 19 June 2024 13:40

You will most likely want to expose them as separate addon to not to have your own fork of ayon-core.

Your addon can contain logic where these loader plugins will appear (in which hosts), see ayon-openrv/client/ayon_openrv/addon.py at 723463e97fc37332f0c5f2872c1b5f4ca2b460cb · ynput/ayon-openrv · GitHub for inspiration.