Skip to content

extract_pointcache

Plugin for extracting point cache data from Marvelous Designer.

This module provides extractors for exporting geometry and animation data in various formats (Alembic, OBJ, FBX) from Marvelous Designer.

ExtractFbx

Bases: ExtractPointCache

Extract Geometry in FBX Format.

Source code in client/ayon_marvelousdesigner/plugins/publish/extract_pointcache.py
216
217
218
219
220
class ExtractFbx(ExtractPointCache):
    """Extract Geometry in FBX Format."""

    label = "Extract FBX"
    extension = "fbx"

ExtractObj

Bases: ExtractPointCache

Extract PointCache in OBJ Format.

Source code in client/ayon_marvelousdesigner/plugins/publish/extract_pointcache.py
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
class ExtractObj(ExtractPointCache):
    """Extract PointCache in OBJ Format."""

    label = "Extract OBJ"
    extension = "obj"

    def process(self, instance: pyblish.api.Instance) -> None:
        """Process the instance to extract point cache data in OBJ format.

        This method extends the base process method to handle additional
        XML metadata extraction specific to OBJ exports.

        Args:
            instance (pyblish.api.Instance): The instance to process
            for extraction.

        """
        super().process(instance)

        stagingdir = self.staging_dir(instance)
        xml_filename = f"{instance.name}_meta_data.xml"

        xml_output = Path(stagingdir) / xml_filename
        if os.path.exists(xml_output):
            xml_rep = Representation(
                "xml",
                traits=[
                    Static(),
                    FileLocation(file_path=xml_output),
                    Persistent(),
                ],
            )

            try:
                xml_rep.validate()

            except TraitValidationError as e:
                msg = f"Representation {xml_rep.name} is invalid: {e}"
                self.log.exception(msg)
            finally:
                add_trait_representations(instance, [xml_rep])

            self.log.info(
                "Extracted instance '%s: %s' to: %s",
                instance.name,
                xml_rep.name,
                xml_rep.get_trait(FileLocation).file_path,
            )

process(instance)

Process the instance to extract point cache data in OBJ format.

This method extends the base process method to handle additional XML metadata extraction specific to OBJ exports.

Parameters:

Name Type Description Default
instance Instance

The instance to process

required
Source code in client/ayon_marvelousdesigner/plugins/publish/extract_pointcache.py
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
def process(self, instance: pyblish.api.Instance) -> None:
    """Process the instance to extract point cache data in OBJ format.

    This method extends the base process method to handle additional
    XML metadata extraction specific to OBJ exports.

    Args:
        instance (pyblish.api.Instance): The instance to process
        for extraction.

    """
    super().process(instance)

    stagingdir = self.staging_dir(instance)
    xml_filename = f"{instance.name}_meta_data.xml"

    xml_output = Path(stagingdir) / xml_filename
    if os.path.exists(xml_output):
        xml_rep = Representation(
            "xml",
            traits=[
                Static(),
                FileLocation(file_path=xml_output),
                Persistent(),
            ],
        )

        try:
            xml_rep.validate()

        except TraitValidationError as e:
            msg = f"Representation {xml_rep.name} is invalid: {e}"
            self.log.exception(msg)
        finally:
            add_trait_representations(instance, [xml_rep])

        self.log.info(
            "Extracted instance '%s: %s' to: %s",
            instance.name,
            xml_rep.name,
            xml_rep.get_trait(FileLocation).file_path,
        )

ExtractPointCache

Bases: Extractor, OptionalPyblishPluginMixin

Extract Geometry in Alembic Format.

Source code in client/ayon_marvelousdesigner/plugins/publish/extract_pointcache.py
 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
158
159
160
161
162
163
class ExtractPointCache(publish.Extractor, OptionalPyblishPluginMixin):
    """Extract Geometry in Alembic Format."""

    order = pyblish.api.ExtractorOrder - 0.05
    label = "Extract PointCache (Alembic)"
    hosts: ClassVar[list[str]] = ["marvelousdesigner"]
    families: ClassVar[list[str]] = ["model", "pointcache"]
    optional = True
    extension = "abc"

    def process(self, instance: pyblish.api.Instance) -> None:
        """Process the instance to extract point cache data.

        Args:
            instance (pyblish.api.Instance): The instance to process
            for extraction.

        Raises:
            KnownPublishError: If the output file wasn't produced by
            Marvelous Designer.
        """
        if not self.is_active(instance.data):
            return

        stagingdir = self.staging_dir(instance)
        filename = f"{instance.name}.{self.extension}"
        filepath = Path(stagingdir) / filename

        export_option = self.export_option(instance)

        output_files = self._export_mesh(filepath.as_posix(), export_option)
        if not output_files:
            msg = (
                f"Files [{output_files}] wasn't produced by Marvelous "
                "Designer, please check the logs."
            )
            raise KnownPublishError(
                msg
            )
        up_axis = self.get_up_axis(export_option)
        rep = Representation(
            self.extension,
            traits=[
                Static(),
                FileLocation(file_path=Path(stagingdir) / filename),
                Persistent(),
                Geometry(),
                Spatial(
                    up_axis=up_axis,
                    handedness="right",
                    meters_per_unit=export_option.scale / 100.0,
                ),
            ],
        )

        try:
            rep.validate()
        except TraitValidationError as e:
            msg = f"Representation {rep.name} is invalid: {e}"
            self.log.exception(msg)
        finally:
            add_trait_representations(instance, [rep])

        self.log.info(
            "Extracted instance '%s: %s' to: %s",
            instance.name,
            rep.name,
            rep.get_trait(FileLocation).file_path)

    def _export_mesh(
            self,
            filepath: str,
            export_options: ApiTypes.ImportExportOption
        ) -> str:
        """Export mesh to filepath.

        Args:
            filepath (str): filepath
            export_options (ApiTypes.ImportExportOption): export options

        Returns:
            str: Output file paths

        Raises:
            KnownPublishError: If the export format is not supported.
        """
        if self.extension == "abc":
            return export_api.ExportAlembicW(filepath, export_options)
        if self.extension == "fbx":
            return export_api.ExportFBXW(filepath, export_options)
        if self.extension == "obj":
            return export_api.ExportOBJW(filepath, export_options)

        msg = f"Unsupported export format: {self.extension}"
        raise KnownPublishError(msg)

    @staticmethod
    def export_option(
            instance: pyblish.api.Instance
        ) -> ApiTypes.ImportExportOption:
        """Get export options for point cache export.

        Returns:
            ApiTypes.ImportExportOption: export options
        """
        export_option = ApiTypes.ImportExportOption()
        options = instance.data["exportOptions"]
        export_option.bExportGarment = options.get("bExportGarment", True)
        export_option.bExportAvatar = options.get("bExportAvatar", False)
        export_option.bSingleObject = options.get("bSingleObject", True)
        export_option.bThin = options.get("bThin", False)
        export_option.bMetaData = options.get("bMetaData", True)
        return export_option

    @staticmethod
    def get_up_axis(
            export_option: ApiTypes.ImportExportOption
        ) -> str:
        """Determine the up axis based on export options.

        Args:
            export_option (ApiTypes.ImportExportOption): Export options.

        Returns:
            str: The up axis ("Y" or "Z").
        """
        if export_option.axisY == 1:
            return "Y"
        if export_option.axisZ == 1:
            return "Z"
        if export_option.axisX == 1:
            return "X"
        return "Y"  # Default to Y if not specified

export_option(instance) staticmethod

Get export options for point cache export.

Returns:

Type Description
ImportExportOption

ApiTypes.ImportExportOption: export options

Source code in client/ayon_marvelousdesigner/plugins/publish/extract_pointcache.py
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
@staticmethod
def export_option(
        instance: pyblish.api.Instance
    ) -> ApiTypes.ImportExportOption:
    """Get export options for point cache export.

    Returns:
        ApiTypes.ImportExportOption: export options
    """
    export_option = ApiTypes.ImportExportOption()
    options = instance.data["exportOptions"]
    export_option.bExportGarment = options.get("bExportGarment", True)
    export_option.bExportAvatar = options.get("bExportAvatar", False)
    export_option.bSingleObject = options.get("bSingleObject", True)
    export_option.bThin = options.get("bThin", False)
    export_option.bMetaData = options.get("bMetaData", True)
    return export_option

get_up_axis(export_option) staticmethod

Determine the up axis based on export options.

Parameters:

Name Type Description Default
export_option ImportExportOption

Export options.

required

Returns:

Name Type Description
str str

The up axis ("Y" or "Z").

Source code in client/ayon_marvelousdesigner/plugins/publish/extract_pointcache.py
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
@staticmethod
def get_up_axis(
        export_option: ApiTypes.ImportExportOption
    ) -> str:
    """Determine the up axis based on export options.

    Args:
        export_option (ApiTypes.ImportExportOption): Export options.

    Returns:
        str: The up axis ("Y" or "Z").
    """
    if export_option.axisY == 1:
        return "Y"
    if export_option.axisZ == 1:
        return "Z"
    if export_option.axisX == 1:
        return "X"
    return "Y"  # Default to Y if not specified

process(instance)

Process the instance to extract point cache data.

Parameters:

Name Type Description Default
instance Instance

The instance to process

required

Raises:

Type Description
KnownPublishError

If the output file wasn't produced by

Source code in client/ayon_marvelousdesigner/plugins/publish/extract_pointcache.py
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
def process(self, instance: pyblish.api.Instance) -> None:
    """Process the instance to extract point cache data.

    Args:
        instance (pyblish.api.Instance): The instance to process
        for extraction.

    Raises:
        KnownPublishError: If the output file wasn't produced by
        Marvelous Designer.
    """
    if not self.is_active(instance.data):
        return

    stagingdir = self.staging_dir(instance)
    filename = f"{instance.name}.{self.extension}"
    filepath = Path(stagingdir) / filename

    export_option = self.export_option(instance)

    output_files = self._export_mesh(filepath.as_posix(), export_option)
    if not output_files:
        msg = (
            f"Files [{output_files}] wasn't produced by Marvelous "
            "Designer, please check the logs."
        )
        raise KnownPublishError(
            msg
        )
    up_axis = self.get_up_axis(export_option)
    rep = Representation(
        self.extension,
        traits=[
            Static(),
            FileLocation(file_path=Path(stagingdir) / filename),
            Persistent(),
            Geometry(),
            Spatial(
                up_axis=up_axis,
                handedness="right",
                meters_per_unit=export_option.scale / 100.0,
            ),
        ],
    )

    try:
        rep.validate()
    except TraitValidationError as e:
        msg = f"Representation {rep.name} is invalid: {e}"
        self.log.exception(msg)
    finally:
        add_trait_representations(instance, [rep])

    self.log.info(
        "Extracted instance '%s: %s' to: %s",
        instance.name,
        rep.name,
        rep.get_trait(FileLocation).file_path)