Skip to content

extract_abc

ExtractABC

Bases: BlenderExtractor, OptionalPyblishPluginMixin

Extract as ABC.

Source code in client/ayon_blender/plugins/publish/extract_abc.py
10
11
12
13
14
15
16
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
class ExtractABC(plugin.BlenderExtractor, publish.OptionalPyblishPluginMixin):
    """Extract as ABC."""

    label = "Extract ABC"
    hosts = ["blender"]
    families = ["pointcache"]

    def process(self, instance):
        if not self.is_active(instance.data):
            return

        attr_values = self.get_attr_values_from_data(instance.data)

        # Define extract output file path
        stagingdir = self.staging_dir(instance)
        folder_name = instance.data["folderEntity"]["name"]
        product_name = instance.data["productName"]
        instance_name = f"{folder_name}_{product_name}"
        filename = f"{instance_name}.abc"
        filepath = os.path.join(stagingdir, filename)

        # Perform extraction
        self.log.debug("Performing extraction..")

        plugin.deselect_all()

        asset_group = instance.data["transientData"]["instance_node"]

        selected = []
        for obj in instance:
            if isinstance(obj, bpy.types.Object):
                obj.select_set(True)
                selected.append(obj)

        context = plugin.create_blender_context(
            active=asset_group, selected=selected)

        # Supply frame range if set on instance
        kwargs = {}
        if "frameStartHandle" in instance.data:
            kwargs["start"]: int = instance.data["frameStartHandle"]
        if "frameEndHandle" in instance.data:
            kwargs["end"]: int = instance.data["frameEndHandle"]

        with bpy.context.temp_override(**context):
            # We export the abc
            bpy.ops.wm.alembic_export(
                filepath=filepath,
                selected=True,
                flatten=False,
                subdiv_schema=attr_values.get("subdiv_schema", False),
                **kwargs
            )

        plugin.deselect_all()

        if "representations" not in instance.data:
            instance.data["representations"] = []

        representation = {
            'name': 'abc',
            'ext': 'abc',
            'files': filename,
            "stagingDir": stagingdir,
        }
        instance.data["representations"].append(representation)

        self.log.debug("Extracted instance '%s' to: %s",
                       instance.name, representation)

    @classmethod
    def get_attribute_defs(cls):
        return [
            BoolDef(
                "subdiv_schema",
                label="Alembic Mesh Subdiv Schema",
                tooltip="Export Meshes using Alembic's subdivision schema.\n"
                        "Enabling this includes creases with the export but "
                        "excludes the mesh's normals.\n"
                        "Enabling this usually result in smaller file size "
                        "due to lack of normals.",
                default=False
            )
        ]

ExtractModelABC

Bases: ExtractABC

Extract model as ABC.

Source code in client/ayon_blender/plugins/publish/extract_abc.py
 96
 97
 98
 99
100
101
102
class ExtractModelABC(ExtractABC):
    """Extract model as ABC."""

    label = "Extract Model ABC"
    hosts = ["blender"]
    families = ["model"]
    optional = True