Skip to content

extract_workfile_xgen

ExtractWorkfileXgen

Bases: MayaExtractorPlugin

Extract Workfile Xgen.

When submitting a render, we need to prep Xgen side car files.

Source code in client/ayon_maya/plugins/publish/extract_workfile_xgen.py
 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
 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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
class ExtractWorkfileXgen(plugin.MayaExtractorPlugin):
    """Extract Workfile Xgen.

    When submitting a render, we need to prep Xgen side car files.
    """

    # Offset to run before workfile scene save.
    order = pyblish.api.ExtractorOrder - 0.499
    label = "Extract Workfile Xgen"
    families = ["workfile"]

    def get_render_max_frame_range(self, context):
        """Return start to end frame range including all renderlayers in
        context.

         This will return the full frame range which includes all frames of the
         renderlayer instances to be published/submitted.

         Args:
            context (pyblish.api.Context): Current publishing context.

         Returns:
            tuple or None: Start frame, end frame tuple if any renderlayers
                found. Otherwise None is returned.

         """

        def _is_active_renderlayer(i):
            """Return whether instance is active renderlayer"""
            if not i.data.get("publish", True):
                return False

            is_renderlayer = (
                "renderlayer" in i.data.get("families", []) or
                i.data["productType"] == "renderlayer"
            )
            return is_renderlayer

        start_frame = None
        end_frame = None
        for instance in context:
            if not _is_active_renderlayer(instance):
                # Only consider renderlyare instances
                continue

            render_start_frame = instance.data["frameStart"]
            render_end_frame = instance.data["frameEnd"]

            if start_frame is None:
                start_frame = render_start_frame
            else:
                start_frame = min(start_frame, render_start_frame)

            if end_frame is None:
                end_frame = render_end_frame
            else:
                end_frame = max(end_frame, render_end_frame)

        if start_frame is None or end_frame is None:
            return

        return start_frame, end_frame

    def process(self, instance):
        transfers = []

        # Validate there is any palettes in the scene.
        if not cmds.ls(type="xgmPalette"):
            self.log.debug(
                "No collections found in the scene. Skipping Xgen extraction."
            )
            return

        import xgenm

        # Validate to extract only when we are publishing a renderlayer as
        # well.
        render_range = self.get_render_max_frame_range(instance.context)
        if not render_range:
            self.log.debug(
                "No publishable renderlayers found in context. Skipping Xgen"
                " extraction."
            )
            return

        start_frame, end_frame = render_range

        # We decrement start frame and increment end frame so motion blur will
        # render correctly.
        start_frame -= 1
        end_frame += 1

        # Extract patches alembic.
        path_no_ext, _ = os.path.splitext(instance.context.data["currentFile"])
        kwargs = {"attrPrefix": ["xgen"], "stripNamespaces": True}
        alembic_files = []
        for palette in cmds.ls(type="xgmPalette"):
            patch_names = []
            for description in xgenm.descriptions(palette):
                for name in xgenm.boundGeometry(palette, description):
                    patch_names.append(name)

            alembic_file = "{}__{}.abc".format(
                path_no_ext, palette.replace(":", "__ns__")
            )
            extract_alembic(
                alembic_file,
                root=patch_names,
                selection=False,
                startFrame=float(start_frame),
                endFrame=float(end_frame),
                verbose=True,
                **kwargs
            )
            alembic_files.append(alembic_file)

        template_data = copy.deepcopy(instance.data["anatomyData"])
        anatomy = instance.context.data["anatomy"]
        publish_template = anatomy.get_template_item(
            "publish", "default", "file"
        )
        published_maya_path = publish_template.format(template_data)
        published_basename, _ = os.path.splitext(published_maya_path)

        for source in alembic_files:
            destination = os.path.join(
                os.path.dirname(instance.data["resourcesDir"]),
                os.path.basename(
                    source.replace(path_no_ext, published_basename)
                )
            )
            transfers.append((source, destination))

        # Validate that we are using the published workfile.
        deadline_settings = instance.context.get("deadline")
        if deadline_settings:
            publish_settings = deadline_settings["publish"]
            if not publish_settings["MayaSubmitDeadline"]["use_published"]:
                self.log.debug(
                    "Not using the published workfile. Abort Xgen extraction."
                )
                return

        # Collect Xgen and Delta files.
        xgen_files = []
        sources = []
        current_dir = os.path.dirname(instance.context.data["currentFile"])
        attrs = ["xgFileName", "xgBaseFile"]
        for palette in cmds.ls(type="xgmPalette"):
            for attr in attrs:
                source = os.path.join(
                    current_dir, cmds.getAttr(palette + "." + attr)
                )
                if not os.path.exists(source):
                    continue

                ext = os.path.splitext(source)[1]
                if ext == ".xgen":
                    xgen_files.append(source)
                if ext == ".xgd":
                    sources.append(source)

        # Copy .xgen file to temporary location and modify.
        staging_dir = self.staging_dir(instance)
        for source in xgen_files:
            destination = os.path.join(staging_dir, os.path.basename(source))
            shutil.copy(source, destination)

            lines = []
            with open(destination, "r") as f:
                for line in [line.rstrip() for line in f]:
                    if line.startswith("\txgProjectPath"):
                        path = os.path.dirname(instance.data["resourcesDir"])
                        line = "\txgProjectPath\t\t{}/".format(
                            path.replace("\\", "/")
                        )

                    lines.append(line)

            with open(destination, "w") as f:
                f.write("\n".join(lines))

            sources.append(destination)

        # Add resource files to workfile instance.
        for source in sources:
            basename = os.path.basename(source)
            destination = os.path.join(
                os.path.dirname(instance.data["resourcesDir"]), basename
            )
            transfers.append((source, destination))

        destination_dir = os.path.join(
            instance.data["resourcesDir"], "collections"
        )
        for palette in cmds.ls(type="xgmPalette"):
            project_path = xgenm.getAttr("xgProjectPath", palette)
            data_path = xgenm.getAttr("xgDataPath", palette)
            data_path = data_path.replace("${PROJECT}", project_path)
            for path in data_path.split(";"):
                for root, _, files in os.walk(path):
                    for f in files:
                        source = os.path.join(root, f)
                        destination = "{}/{}{}".format(
                            destination_dir,
                            palette.replace(":", "__ns__"),
                            source.replace(path, "")
                        )
                        transfers.append((source, destination))

        for source, destination in transfers:
            self.log.debug("Transfer: {} > {}".format(source, destination))

        instance.data["transfers"] = transfers

        # Set palette attributes in preparation for workfile publish.
        attrs = {"xgFileName": None, "xgBaseFile": ""}
        data = {}
        for palette in cmds.ls(type="xgmPalette"):
            attrs["xgFileName"] = "resources/{}.xgen".format(
                palette.replace(":", "__ns__")
            )
            for attr, value in attrs.items():
                node_attr = palette + "." + attr

                old_value = cmds.getAttr(node_attr)
                try:
                    data[palette][attr] = old_value
                except KeyError:
                    data[palette] = {attr: old_value}

                cmds.setAttr(node_attr, value, type="string")
                self.log.debug(
                    "Setting \"{}\" on \"{}\"".format(value, node_attr)
                )

            cmds.setAttr(palette + "." + "xgExportAsDelta", False)

        instance.data["xgenAttributes"] = data

get_render_max_frame_range(context)

Return start to end frame range including all renderlayers in context.

This will return the full frame range which includes all frames of the renderlayer instances to be published/submitted.

Args: context (pyblish.api.Context): Current publishing context.

Returns: tuple or None: Start frame, end frame tuple if any renderlayers found. Otherwise None is returned.

Source code in client/ayon_maya/plugins/publish/extract_workfile_xgen.py
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
def get_render_max_frame_range(self, context):
    """Return start to end frame range including all renderlayers in
    context.

     This will return the full frame range which includes all frames of the
     renderlayer instances to be published/submitted.

     Args:
        context (pyblish.api.Context): Current publishing context.

     Returns:
        tuple or None: Start frame, end frame tuple if any renderlayers
            found. Otherwise None is returned.

     """

    def _is_active_renderlayer(i):
        """Return whether instance is active renderlayer"""
        if not i.data.get("publish", True):
            return False

        is_renderlayer = (
            "renderlayer" in i.data.get("families", []) or
            i.data["productType"] == "renderlayer"
        )
        return is_renderlayer

    start_frame = None
    end_frame = None
    for instance in context:
        if not _is_active_renderlayer(instance):
            # Only consider renderlyare instances
            continue

        render_start_frame = instance.data["frameStart"]
        render_end_frame = instance.data["frameEnd"]

        if start_frame is None:
            start_frame = render_start_frame
        else:
            start_frame = min(start_frame, render_start_frame)

        if end_frame is None:
            end_frame = render_end_frame
        else:
            end_frame = max(end_frame, render_end_frame)

    if start_frame is None or end_frame is None:
        return

    return start_frame, end_frame