Skip to content

collect_render

Collect Render

CollectRender

Bases: InstancePlugin

Collect Render for Deadline

Source code in client/ayon_max/plugins/publish/collect_render.py
 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
class CollectRender(pyblish.api.InstancePlugin):
    """Collect Render for Deadline"""

    order = pyblish.api.CollectorOrder + 0.02
    label = "Collect 3dsmax Render Layers"
    hosts = ["max"]
    families = ["maxrender"]
    settings_category = "max"

    # Settings
    sync_workfile_version = False

    def process(self, instance):
        context = instance.context
        filepath = context.data["currentFile"]
        filename = os.path.basename(filepath)
        filename_pattern = os.path.splitext(filename)[0].strip(".")
        renderer = get_current_renderer()
        renderer_name = str(renderer).split(":")[0]
        renderproducts = RenderProducts(context.data["project_settings"])
        img_format = renderproducts.image_format()
        files_by_aov: Dict[str, list[str]] = renderproducts.get_render_products()


        camera = rt.viewport.GetCamera()
        camera_list = get_cameras_from_node(instance.data.get("members"))
        if camera_list:
            camera = camera_list[-1]

        instance.data["cameras"] = [camera.name] if camera else None        # noqa

        if instance.data.get("multiCamera"):
            cameras = instance.data.get("members")
            if not cameras:
                raise KnownPublishError("There should be at least"
                                        " one renderable camera in container")

            sel_cam = [camera.name for camera in get_cameras_from_node(cameras)]

            render_output = self.get_render_output(
                renderer,
                renderer_name,
                img_format,
                context.data["project_settings"]
            )
            render_dir = os.path.dirname(render_output)

            container_name = instance.data.get("instance_node")
            outputs = RenderSettings().batch_render_layers_by_multi_camera(
                container_name, render_dir, sel_cam
            )

            instance.data["cameras"] = sel_cam

            files_by_aov = renderproducts.get_multiple_render_products(
                outputs, sel_cam
            )

        if "expectedFiles" not in instance.data:
            instance.data["expectedFiles"] = list()
            instance.data["files"] = list()
            instance.data["expectedFiles"].append(files_by_aov)
            instance.data["files"].append(files_by_aov)
        # OCIO config not support in
        # most of the 3dsmax renderers
        # so this is currently hard coded
        # TODO: add options for redshift/vray ocio config
        instance.data["colorspaceConfig"] = ""
        instance.data["colorspaceDisplay"] = "sRGB"
        instance.data["colorspaceView"] = "ACES 1.0 SDR-video"

        if int(get_max_version()) >= 2024:
            colorspace_mgr = rt.ColorPipelineMgr      # noqa
            display = next(
                (display for display in colorspace_mgr.GetDisplayList()))
            view_transform = next(
                (view for view in colorspace_mgr.GetViewList(display)))
            instance.data["colorspaceConfig"] = colorspace_mgr.OCIOConfigPath
            instance.data["colorspaceDisplay"] = display
            instance.data["colorspaceView"] = view_transform

        instance.data["renderProducts"] = colorspace.ARenderProduct()
        instance.data["publishJobState"] = "Suspended"
        instance.data["attachTo"] = []

        product_base_type = "maxrender"

        # Keep custom product type only if is not the same
        #   as product base type
        product_type = instance.data["productType"]
        if product_type == instance.data["productBaseType"]:
            product_type = product_base_type

        creator_attribute = instance.data.get("creator_attributes", {})
        farm_render: bool = (
            creator_attribute.get("render_target", "farm") == "farm"
        )
        self._precollect_required_data(instance)

        # also need to get the render dir for conversion
        data = {
            "folderPath": instance.data["folderPath"],
            "workfile_name": filename,
            "productName": str(instance.name),
            "publish": True,
            "original_workfile_pattern": filename_pattern,
            "maxversion": str(get_max_version()),
            "imageFormat": img_format,
            "productBaseType": product_base_type,
            "productType": product_type,
            "family": product_base_type,
            "families": [product_base_type],
            "renderer": renderer_name,
            "source": filepath,
            "plugin": "3dsmax",
            "frameStart": instance.data["frameStartHandle"],
            "frameEnd": instance.data["frameEndHandle"],
            "resolutionWidth": rt.renderWidth,
            "resolutionHeight": rt.renderHeight,
            "farm": farm_render
        }

        # sync workfile version
        if self.sync_workfile_version:
            data["version"] = context.data["version"]
            for _instance in context:
                if _instance.data["productBaseType"] == "workfile":
                    _instance.data["version"] = context.data["version"]

        instance.data.update(data)
        # TODO: this should be unified with maya and its "multipart" flag
        #       on instance.
        if renderer_name == "Redshift_Renderer":
            instance.data.update(
                {"separateAovFiles": rt.Execute(
                    "renderers.current.separateAovFiles")})

        self.log.info("data: {0}".format(data))

    def get_render_output(
            self,
            renderer: Any,
            renderer_name: str,
            img_format: str,
            project_settings: Dict
        ) -> str:
        """Get render output path for the given renderer and instance.

        Args:
            renderer (Any, rt.Renderers.current): The renderer to get the
                output path from.
            renderer_name (str): The name of the renderer.
            img_format (str): The image format.
            project_settings (Dict): The project settings.

        Returns:
            str: The render output path.
        """
        if renderer_name == "Redshift_Renderer":
            return rt.rendOutputFilename
        elif renderer_name == "Arnold_Renderer":
            return renderer.AOVManager.outputPath
        elif renderer_name.startswith("V-Ray"):
            vr_settings = get_vray_settings(renderer_name, renderer)
            multipass = get_multipass_setting(renderer, project_settings)
            if multipass and img_format == "exr":
                return vr_settings.output_rawfilename
            else:
                return vr_settings.output_splitfilename
        return rt.rendOutputFilename

    def _precollect_required_data(self, instance: pyblish.api.Instance) -> None:
        """Ensure required data is present.

        Some data may not exist yet in the instance at this point, so we need
        to ensure it is there for certain function calls, like
        `create_instances_for_aov` requiring `taskEntity` in instance data
        if setting `use_legacy_product_names_for_renders` is disabled which is
        usually collected at a later order by `CollectAnatomyInstanceData`.

        Args:
            instance (pyblish.api.Instance): The instance to ensure data for.
        """

        project_name: str = instance.context.data["projectName"]

        # Add folderEntity
        if "folderEntity" not in instance.data:
            self.log.debug("Collecting folder entity for instance...")
            instance.data["folderEntity"] = ayon_api.get_folder_by_path(
                project_name=project_name,
                folder_path=instance.data["folderPath"],
            )
        folder_entity = instance.data["folderEntity"]

        # Add taskEntity
        if "taskEntity" not in instance.data:
            self.log.debug("Collecting task entity for instance...")
            project_name: str = instance.context.data["projectName"]
            instance.data["taskEntity"] = ayon_api.get_task_by_name(
                project_name=project_name,
                task_name=instance.data["task"],
                folder_id=folder_entity["id"],
            )

get_render_output(renderer, renderer_name, img_format, project_settings)

Get render output path for the given renderer and instance.

Parameters:

Name Type Description Default
renderer (Any, current)

The renderer to get the output path from.

required
renderer_name str

The name of the renderer.

required
img_format str

The image format.

required
project_settings Dict

The project settings.

required

Returns:

Name Type Description
str str

The render output path.

Source code in client/ayon_max/plugins/publish/collect_render.py
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
def get_render_output(
        self,
        renderer: Any,
        renderer_name: str,
        img_format: str,
        project_settings: Dict
    ) -> str:
    """Get render output path for the given renderer and instance.

    Args:
        renderer (Any, rt.Renderers.current): The renderer to get the
            output path from.
        renderer_name (str): The name of the renderer.
        img_format (str): The image format.
        project_settings (Dict): The project settings.

    Returns:
        str: The render output path.
    """
    if renderer_name == "Redshift_Renderer":
        return rt.rendOutputFilename
    elif renderer_name == "Arnold_Renderer":
        return renderer.AOVManager.outputPath
    elif renderer_name.startswith("V-Ray"):
        vr_settings = get_vray_settings(renderer_name, renderer)
        multipass = get_multipass_setting(renderer, project_settings)
        if multipass and img_format == "exr":
            return vr_settings.output_rawfilename
        else:
            return vr_settings.output_splitfilename
    return rt.rendOutputFilename

get_cameras_from_node(members)

Get camera from instance members.

Parameters:

Name Type Description Default
members list

The list of instance members.

required

Returns:

Name Type Description
list list

A list of camera objects.

Source code in client/ayon_max/plugins/publish/collect_render.py
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def get_cameras_from_node(members) -> list:
    """Get camera from instance members.

    Args:
        members (list): The list of instance members.

    Returns:
        list: A list of camera objects.
    """
    cameras = []
    for member in members:
        if rt.classOf(member) in rt.Camera.classes:
            cameras.append(member)
        if hasattr(member, "children"):
            for child in member.children:
                if rt.classOf(child) in rt.Camera.classes:
                    cameras.append(child)
    return cameras