Skip to content

load_action

Load an action in Blender.

BlendActionLoader

Bases: BlenderLoader

Load action from a .blend file.

Warning

Loading the same asset more then once is not properly supported at the moment.

Source code in client/ayon_blender/plugins/load/load_action.py
 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
class BlendActionLoader(plugin.BlenderLoader):
    """Load action from a .blend file.

    Warning:
        Loading the same asset more then once is not properly supported at the
        moment.
    """

    product_types = {"action"}
    representations = {"blend"}

    label = "Link Action"
    icon = "code-fork"
    color = "orange"

    options = [
        BoolDef(
            "use_fake_user",
            label="Use Fake User",
            default=True,
            tooltip="Set the fake user for the loaded asset.",
        )
    ]

    def process_asset(
        self, context: dict, name: str, namespace: Optional[str] = None,
        options: Optional[Dict] = None
    ) -> Optional[List]:
        """
        Arguments:
            name: Use pre-defined name
            namespace: Use pre-defined namespace
            context: Full parenthood of representation to load
            options: Additional settings dictionary
        """

        libpath = self.filepath_from_context(context)
        folder_name = context["folder"]["name"]
        product_name = context["product"]["name"]
        lib_container = plugin.prepare_scene_name(folder_name, product_name)

        container = bpy.data.collections.new(lib_container)
        containerise_existing(
            container,
            name,
            namespace,
            context,
            self.__class__.__name__,
        )

        container_metadata = container.get(AYON_PROPERTY)


        relative = bpy.context.preferences.filepaths.use_relative_paths
        with bpy.data.libraries.load(
            libpath, link=True, relative=relative
        ) as (data_from, data_to):
            data_to.actions = data_from.actions
        if not data_to.actions:
            raise LoadError(
                "No action found in the file, please check if "
                "there is any action datablock in the blend file."
            )
        container = data_to.actions[0]

        empty_obj = bpy.data.objects.new(name=name, object_data=None)
        empty_obj.animation_data_create()
        empty_obj.animation_data.action = container
        empty_obj.animation_data.action.use_fake_user = options.get(
            "use_fake_user", True
        )
        # Save the list of objects in the metadata container
        container_metadata["libpath"] = libpath
        container_metadata["lib_container"] = lib_container
        container_metadata["objects"] = empty_obj
        container_metadata["action"] = empty_obj.animation_data.action

        metadata_update(container, container_metadata)
        bpy.ops.object.select_all(action='DESELECT')
        self[:] = [empty_obj]

        # show message dialog to notify the users the action is loaded
        show_message("Action loaded", f"Action {container.name} loaded successfully.")

        return container

    def update(self, container: Dict, context: Dict):
        """Update the loaded asset.

        This will remove all objects of the current collection, load the new
        ones and add them to the collection.
        If the objects of the collection are used in another collection they
        will not be removed, only unlinked. Normally this should not be the
        case though.

        Warning:
            No nested collections are supported at the moment!
        """
        repre_entity = context["representation"]
        collection = container["node"]
        libpath = self.filepath_from_context(context)
        action = container["action"]
        if action.library:
            action.library.name = os.path.basename(libpath)
            action.library.filepath = libpath

        metadata_update(
            collection, {"representation": str(repre_entity["id"])}
        )

    def remove(self, container: Dict) -> bool:
        """Remove an existing container from a Blender scene.

        Arguments:
            container (ayon:container-1.0): Container to remove,
                from `host.ls()`.

        Returns:
            bool: Whether the container was deleted.

        Warning:
            No nested collections are supported at the moment!
        """

        collection = bpy.data.collections.get(
            container["objectName"]
        )
        if not collection:
            return False

        action = container["action"]
        bpy.data.actions.remove(action)
        bpy.data.collections.remove(collection)

        return True

process_asset(context, name, namespace=None, options=None)

Parameters:

Name Type Description Default
name str

Use pre-defined name

required
namespace Optional[str]

Use pre-defined namespace

None
context dict

Full parenthood of representation to load

required
options Optional[Dict]

Additional settings dictionary

None
Source code in client/ayon_blender/plugins/load/load_action.py
 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
def process_asset(
    self, context: dict, name: str, namespace: Optional[str] = None,
    options: Optional[Dict] = None
) -> Optional[List]:
    """
    Arguments:
        name: Use pre-defined name
        namespace: Use pre-defined namespace
        context: Full parenthood of representation to load
        options: Additional settings dictionary
    """

    libpath = self.filepath_from_context(context)
    folder_name = context["folder"]["name"]
    product_name = context["product"]["name"]
    lib_container = plugin.prepare_scene_name(folder_name, product_name)

    container = bpy.data.collections.new(lib_container)
    containerise_existing(
        container,
        name,
        namespace,
        context,
        self.__class__.__name__,
    )

    container_metadata = container.get(AYON_PROPERTY)


    relative = bpy.context.preferences.filepaths.use_relative_paths
    with bpy.data.libraries.load(
        libpath, link=True, relative=relative
    ) as (data_from, data_to):
        data_to.actions = data_from.actions
    if not data_to.actions:
        raise LoadError(
            "No action found in the file, please check if "
            "there is any action datablock in the blend file."
        )
    container = data_to.actions[0]

    empty_obj = bpy.data.objects.new(name=name, object_data=None)
    empty_obj.animation_data_create()
    empty_obj.animation_data.action = container
    empty_obj.animation_data.action.use_fake_user = options.get(
        "use_fake_user", True
    )
    # Save the list of objects in the metadata container
    container_metadata["libpath"] = libpath
    container_metadata["lib_container"] = lib_container
    container_metadata["objects"] = empty_obj
    container_metadata["action"] = empty_obj.animation_data.action

    metadata_update(container, container_metadata)
    bpy.ops.object.select_all(action='DESELECT')
    self[:] = [empty_obj]

    # show message dialog to notify the users the action is loaded
    show_message("Action loaded", f"Action {container.name} loaded successfully.")

    return container

remove(container)

Remove an existing container from a Blender scene.

Parameters:

Name Type Description Default
container (ayon

container-1.0): Container to remove, from host.ls().

required

Returns:

Name Type Description
bool bool

Whether the container was deleted.

Warning

No nested collections are supported at the moment!

Source code in client/ayon_blender/plugins/load/load_action.py
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
def remove(self, container: Dict) -> bool:
    """Remove an existing container from a Blender scene.

    Arguments:
        container (ayon:container-1.0): Container to remove,
            from `host.ls()`.

    Returns:
        bool: Whether the container was deleted.

    Warning:
        No nested collections are supported at the moment!
    """

    collection = bpy.data.collections.get(
        container["objectName"]
    )
    if not collection:
        return False

    action = container["action"]
    bpy.data.actions.remove(action)
    bpy.data.collections.remove(collection)

    return True

update(container, context)

Update the loaded asset.

This will remove all objects of the current collection, load the new ones and add them to the collection. If the objects of the collection are used in another collection they will not be removed, only unlinked. Normally this should not be the case though.

Warning

No nested collections are supported at the moment!

Source code in client/ayon_blender/plugins/load/load_action.py
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
def update(self, container: Dict, context: Dict):
    """Update the loaded asset.

    This will remove all objects of the current collection, load the new
    ones and add them to the collection.
    If the objects of the collection are used in another collection they
    will not be removed, only unlinked. Normally this should not be the
    case though.

    Warning:
        No nested collections are supported at the moment!
    """
    repre_entity = context["representation"]
    collection = container["node"]
    libpath = self.filepath_from_context(context)
    action = container["action"]
    if action.library:
        action.library.name = os.path.basename(libpath)
        action.library.filepath = libpath

    metadata_update(
        collection, {"representation": str(repre_entity["id"])}
    )