Skip to content

lib_rendersettings

Class for handling Render Settings.

RenderSettings

Bases: object

Source code in client/ayon_maya/api/lib_rendersettings.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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
class RenderSettings(object):

    _image_prefix_nodes = {
        'vray': 'vraySettings.fileNamePrefix',
        'arnold': 'defaultRenderGlobals.imageFilePrefix',
        'renderman': 'rmanGlobals.imageFileFormat',
        'redshift': 'defaultRenderGlobals.imageFilePrefix',
        'mayahardware2': 'defaultRenderGlobals.imageFilePrefix'
    }

    _aov_chars = {
        "dot": ".",
        "dash": "-",
        "underscore": "_"
    }

    log = Logger.get_logger("RenderSettings")

    @classmethod
    def get_image_prefix_attr(cls, renderer):
        return cls._image_prefix_nodes[renderer]

    @staticmethod
    def get_padding_attr(renderer):
        """Return attribute for renderer that defines frame padding amount"""
        if renderer == "vray":
            return "vraySettings.fileNamePadding"
        else:
            return "defaultRenderGlobals.extensionPadding"

    def __init__(self, project_settings=None):
        if not project_settings:
            project_settings = get_project_settings(
                get_current_project_name()
            )
        render_settings = project_settings["maya"]["render_settings"]
        image_prefixes = {
            "vray": render_settings["vray_renderer"]["image_prefix"],
            "arnold": render_settings["arnold_renderer"]["image_prefix"],
            "renderman": render_settings["renderman_renderer"]["image_prefix"],
            "redshift": render_settings["redshift_renderer"]["image_prefix"]
        }

        # TODO probably should be stored to more explicit attribute
        # Renderman only
        renderman_settings = render_settings["renderman_renderer"]
        _image_dir = {
            "renderman": renderman_settings["image_dir"],
            "cryptomatte": renderman_settings["cryptomatte_dir"],
            "imageDisplay": renderman_settings["imageDisplay_dir"],
            "watermark": renderman_settings["watermark_dir"]
        }
        self._image_prefixes = image_prefixes
        self._image_dir = _image_dir
        self._project_settings = project_settings

    def set_default_renderer_settings(self, renderer=None):
        """Set basic settings based on renderer."""
        # Not all hosts can import this module.
        from maya import cmds  # noqa: F401
        import maya.mel as mel  # noqa: F401

        if not renderer:
            renderer = cmds.getAttr(
                'defaultRenderGlobals.currentRenderer').lower()

        # project_settings/maya/create/CreateRender/aov_separator
        try:
            aov_separator = self._aov_chars[(
                self._project_settings["maya"]
                                      ["render_settings"]
                                      ["aov_separator"]
            )]
        except KeyError:
            aov_separator = "_"
        reset_frame = self._project_settings["maya"]["render_settings"]["reset_current_frame"] # noqa

        if reset_frame:
            start_frame = cmds.getAttr("defaultRenderGlobals.startFrame")
            cmds.currentTime(start_frame, edit=True)

        if renderer in self._image_prefix_nodes:
            prefix = self._image_prefixes[renderer]
            prefix = prefix.replace("{aov_separator}", aov_separator)
            cmds.setAttr(self._image_prefix_nodes[renderer],
                        prefix, type="string")  # noqa
        else:
            print("{0} isn't a supported renderer to autoset settings.".format(renderer)) # noqa

        task_entity = get_current_task_entity(fields={"attrib"})
        task_attributes = task_entity["attrib"]
        width: int = task_attributes["resolutionWidth"]
        height: int = task_attributes["resolutionHeight"]
        pixel_aspect: float = task_attributes["pixelAspect"]
        if renderer == "arnold":
            # set renderer settings for Arnold from project settings
            self._set_arnold_settings()

        if renderer == "vray":
            self._set_vray_settings(width, height, pixel_aspect, aov_separator)

        if renderer == "redshift":
            self._set_redshift_settings()
            mel.eval("redshiftUpdateActiveAovList")

        if renderer == "renderman":
            image_dir = self._image_dir["renderman"]
            cmds.setAttr("rmanGlobals.imageOutputDir",
                         image_dir, type="string")
            self._set_renderman_settings(aov_separator)
        self._set_default_render_resolution(width, height, pixel_aspect)

    def _set_arnold_settings(self):
        """Sets settings for Arnold."""
        from mtoa.core import createOptions  # noqa
        from mtoa.aovs import AOVInterface  # noqa
        # Not all hosts can import this module.
        from maya import cmds  # noqa: F401
        import maya.mel as mel  # noqa: F401

        createOptions()
        render_settings = self._project_settings["maya"]["render_settings"]
        arnold_render_presets = render_settings["arnold_renderer"] # noqa
        # Force resetting settings and AOV list to avoid having to deal with
        # AOV checking logic, for now.
        # This is a work around because the standard
        # function to revert render settings does not reset AOVs list in MtoA
        # Fetch current aovs in case there's any.
        current_aovs = AOVInterface().getAOVs()
        remove_aovs = render_settings["remove_aovs"]
        if remove_aovs:
        # Remove fetched AOVs
            AOVInterface().removeAOVs(current_aovs)
        mel.eval("unifiedRenderGlobalsRevertToDefault")
        img_ext = arnold_render_presets["image_format"]
        img_prefix = arnold_render_presets["image_prefix"]
        aovs = arnold_render_presets["aov_list"]
        img_tiled = arnold_render_presets["tiled"]
        multi_exr = arnold_render_presets["multilayer_exr"]
        additional_options = arnold_render_presets["additional_options"]
        for aov in aovs:
            if aov in current_aovs and not remove_aovs:
                continue
            AOVInterface('defaultArnoldRenderOptions').addAOV(aov)

        self._set_global_output_settings()

        cmds.setAttr(
            "defaultRenderGlobals.imageFilePrefix", img_prefix, type="string")

        cmds.setAttr(
            "defaultArnoldDriver.ai_translator", img_ext, type="string")

        cmds.setAttr(
            "defaultArnoldDriver.exrTiled", img_tiled)

        cmds.setAttr(
            "defaultArnoldDriver.mergeAOVs", multi_exr)
        self._additional_attribs_setter(additional_options)
        reset_frame_range(playback=False, fps=False, render=True)

    def _set_redshift_settings(self):
        """Sets settings for Redshift."""
        # Not all hosts can import this module.
        from maya import cmds  # noqa: F401
        import maya.mel as mel  # noqa: F401

        render_settings = self._project_settings["maya"]["render_settings"]
        redshift_render_presets = render_settings["redshift_renderer"]

        remove_aovs = render_settings["remove_aovs"]
        all_rs_aovs = cmds.ls(type='RedshiftAOV')
        if remove_aovs:
            for aov in all_rs_aovs:
                enabled = cmds.getAttr("{}.enabled".format(aov))
                if enabled:
                    cmds.delete(aov)

        redshift_aovs = redshift_render_presets["aov_list"]
        # list all the aovs
        all_rs_aovs = cmds.ls(type='RedshiftAOV')
        for rs_aov in redshift_aovs:
            rs_layername = "rsAov_{}".format(rs_aov.replace(" ", ""))
            if rs_layername in all_rs_aovs:
                continue
            cmds.rsCreateAov(type=rs_aov)
        # update the AOV list
        mel.eval("redshiftUpdateActiveAovList")

        gi_enabled: bool = redshift_render_presets["gi_enabled"]
        rs_p_engine = int(redshift_render_presets["primary_gi_engine"])
        rs_s_engine = int(redshift_render_presets["secondary_gi_engine"])
        cmds.setAttr("redshiftOptions.GIEnabled", gi_enabled)
        if rs_p_engine != 0:
            cmds.setAttr("redshiftOptions.primaryGIEngine", rs_p_engine)
        if rs_s_engine != 0:
            cmds.setAttr("redshiftOptions.secondaryGIEngine", rs_s_engine)

        additional_options = redshift_render_presets["additional_options"]
        ext = redshift_render_presets["image_format"]
        img_exts = ["iff", "exr", "tif", "png", "tga", "jpg"]
        img_ext = img_exts.index(ext)

        self._set_global_output_settings()
        cmds.setAttr("redshiftOptions.imageFormat", img_ext)
        cmds.setAttr("redshiftOptions.exrMultipart",
                     redshift_render_presets.get("multipart_exr", True))
        cmds.setAttr("redshiftOptions.exrForceMultilayer",
                     redshift_render_presets["force_combine"])
        self._additional_attribs_setter(additional_options)

    def _set_renderman_settings(self, aov_separator: str):
        """Sets settings for Renderman"""
        # Not all hosts can import this module.
        from maya import cmds  # noqa: F401
        import maya.mel as mel  # noqa: F401

        rman_render_presets = (
            self._project_settings
            ["maya"]
            ["render_settings"]
            ["renderman_renderer"]
        )
        display_filters = rman_render_presets["display_filters"]
        d_filters_number = len(display_filters)
        for i in range(d_filters_number):
            d_node = cmds.ls(typ=display_filters[i])
            if len(d_node) > 0:
                filter_nodes = d_node[0]
            else:
                filter_nodes = cmds.createNode(display_filters[i])

            cmds.connectAttr(filter_nodes + ".message",
                             "rmanGlobals.displayFilters[%i]" % i,
                             force=True)
            if filter_nodes.startswith("PxrImageDisplayFilter"):
                imageDisplay_dir = self._image_dir["imageDisplay"]
                imageDisplay_dir = imageDisplay_dir.replace("{aov_separator}",
                                                            aov_separator)
                cmds.setAttr(filter_nodes + ".filename",
                             imageDisplay_dir, type="string")

        sample_filters = rman_render_presets["sample_filters"]
        s_filters_number = len(sample_filters)
        for n in range(s_filters_number):
            s_node = cmds.ls(typ=sample_filters[n])
            if len(s_node) > 0:
                filter_nodes = s_node[0]
            else:
                filter_nodes = cmds.createNode(sample_filters[n])

            cmds.connectAttr(filter_nodes + ".message",
                             "rmanGlobals.sampleFilters[%i]" % n,
                             force=True)

            if filter_nodes.startswith("PxrCryptomatte"):
                matte_dir = self._image_dir["cryptomatte"]
                matte_dir = matte_dir.replace("{aov_separator}",
                                              aov_separator)
                cmds.setAttr(filter_nodes + ".filename",
                             matte_dir, type="string")
            elif filter_nodes.startswith("PxrWatermarkFilter"):
                watermark_dir = self._image_dir["watermark"]
                watermark_dir = watermark_dir.replace("{aov_separator}",
                                                      aov_separator)
                cmds.setAttr(filter_nodes + ".filename",
                             watermark_dir, type="string")

        additional_options = rman_render_presets["additional_options"]

        self._set_global_output_settings()
        self._additional_attribs_setter(additional_options)

    def _set_vray_settings(
        self,
        width: int,
        height: int,
        pixel_aspect: float,
        aov_separator
    ):
        # type: (str, int, int) -> None
        """Sets important settings for Vray."""
        # Not all hosts can import this module.
        from maya import cmds  # noqa: F401
        import maya.mel as mel  # noqa: F401


        settings = cmds.ls(type="VRaySettingsNode")
        node = settings[0] if settings else cmds.createNode("VRaySettingsNode")
        render_settings = self._project_settings["maya"]["render_settings"]
        vray_render_presets = render_settings["vray_renderer"]
        # vrayRenderElement
        remove_aovs = render_settings["remove_aovs"]
        all_vray_aovs = cmds.ls(type='VRayRenderElement')
        lightSelect_aovs = cmds.ls(type='VRayRenderElementSet')
        if remove_aovs:
            for aov in all_vray_aovs:
                # remove all aovs except LightSelect
                enabled = cmds.getAttr("{}.enabled".format(aov))
                if enabled:
                    cmds.delete(aov)
            # remove LightSelect
            for light_aovs in lightSelect_aovs:
                light_enabled = cmds.getAttr("{}.enabled".format(light_aovs))
                if light_enabled:
                    cmds.delete(lightSelect_aovs)

        vray_aovs = vray_render_presets["aov_list"]
        for renderlayer in vray_aovs:
            renderElement = "vrayAddRenderElement {}".format(renderlayer)
            RE_name = mel.eval(renderElement)
            # if there is more than one same render element
            if RE_name.endswith("1"):
                cmds.delete(RE_name)
        # Set aov separator
        # First we need to explicitly set the UI items in Render Settings
        # because that is also what V-Ray updates to when that Render Settings
        # UI did initialize before and refreshes again.
        MENU = "vrayRenderElementSeparator"
        if cmds.optionMenuGrp(MENU, query=True, exists=True):
            items = cmds.optionMenuGrp(MENU, query=True, ill=True)
            separators = [cmds.menuItem(i, query=True, label=True) for i in items]  # noqa: E501
            try:
                sep_idx = separators.index(aov_separator)
            except ValueError as exc:
                raise CreatorError(
                    f"AOV character {aov_separator} not in {separators}"
                ) from exc

            cmds.optionMenuGrp(MENU, edit=True, select=sep_idx + 1)

        # Set the render element attribute as string. This is also what V-Ray
        # sets whenever the `vrayRenderElementSeparator` menu items switch
        cmds.setAttr(
            "{}.fileNameRenderElementSeparator".format(node),
            aov_separator,
            type="string"
        )

        # Set render file format to exr
        ext = vray_render_presets["image_format"]
        cmds.setAttr("{}.imageFormatStr".format(node), ext, type="string")

        # animType
        cmds.setAttr("{}.animType".format(node), 1)

        # resolution
        cmds.setAttr("{}.width".format(node), width)
        cmds.setAttr("{}.height".format(node), height)
        cmds.setAttr("{}.pixelAspect".format(node), pixel_aspect)

        additional_options = vray_render_presets["additional_options"]
        self._additional_attribs_setter(additional_options)

    def _set_default_render_resolution(self,
                                       width: int,
                                       height: int,
                                       pixel_aspect: float):
        from maya import cmds  # noqa: F401
        device_aspect = pixel_aspect * (width / height)
        cmds.setAttr("defaultResolution.width", width)
        cmds.setAttr("defaultResolution.height", height)
        cmds.setAttr("defaultResolution.pixelAspect", pixel_aspect)
        cmds.setAttr("defaultResolution.deviceAspectRatio", device_aspect)

    @staticmethod
    def _set_global_output_settings():
        # Not all hosts can import this module.
        from maya import cmds  # noqa: F401
        import maya.mel as mel  # noqa: F401

        # enable animation
        cmds.setAttr("defaultRenderGlobals.outFormatControl", 0)
        cmds.setAttr("defaultRenderGlobals.animation", 1)
        cmds.setAttr("defaultRenderGlobals.putFrameBeforeExt", 1)
        cmds.setAttr("defaultRenderGlobals.extensionPadding", 4)

    def _additional_attribs_setter(self, additional_attribs):
        # Not all hosts can import this module.
        from maya import cmds  # noqa: F401
        import maya.mel as mel  # noqa: F401

        for item in additional_attribs:
            attribute = item["attribute"]
            value = item["value"]
            attribute = str(attribute)  # ensure str conversion from settings
            attribute_type = cmds.getAttr(attribute, type=True)
            if attribute_type in {"long", "bool"}:
                cmds.setAttr(attribute, int(value))
            elif attribute_type == "string":
                cmds.setAttr(attribute, str(value), type="string")
            elif attribute_type in {"double", "doubleAngle", "doubleLinear"}:
                cmds.setAttr(attribute, float(value))
            else:
                self.log.error(
                    "Attribute {attribute} can not be set due to unsupported "
                    "type: {attribute_type}".format(
                        attribute=attribute,
                        attribute_type=attribute_type)
                )

get_padding_attr(renderer) staticmethod

Return attribute for renderer that defines frame padding amount

Source code in client/ayon_maya/api/lib_rendersettings.py
33
34
35
36
37
38
39
@staticmethod
def get_padding_attr(renderer):
    """Return attribute for renderer that defines frame padding amount"""
    if renderer == "vray":
        return "vraySettings.fileNamePadding"
    else:
        return "defaultRenderGlobals.extensionPadding"

set_default_renderer_settings(renderer=None)

Set basic settings based on renderer.

Source code in client/ayon_maya/api/lib_rendersettings.py
 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
def set_default_renderer_settings(self, renderer=None):
    """Set basic settings based on renderer."""
    # Not all hosts can import this module.
    from maya import cmds  # noqa: F401
    import maya.mel as mel  # noqa: F401

    if not renderer:
        renderer = cmds.getAttr(
            'defaultRenderGlobals.currentRenderer').lower()

    # project_settings/maya/create/CreateRender/aov_separator
    try:
        aov_separator = self._aov_chars[(
            self._project_settings["maya"]
                                  ["render_settings"]
                                  ["aov_separator"]
        )]
    except KeyError:
        aov_separator = "_"
    reset_frame = self._project_settings["maya"]["render_settings"]["reset_current_frame"] # noqa

    if reset_frame:
        start_frame = cmds.getAttr("defaultRenderGlobals.startFrame")
        cmds.currentTime(start_frame, edit=True)

    if renderer in self._image_prefix_nodes:
        prefix = self._image_prefixes[renderer]
        prefix = prefix.replace("{aov_separator}", aov_separator)
        cmds.setAttr(self._image_prefix_nodes[renderer],
                    prefix, type="string")  # noqa
    else:
        print("{0} isn't a supported renderer to autoset settings.".format(renderer)) # noqa

    task_entity = get_current_task_entity(fields={"attrib"})
    task_attributes = task_entity["attrib"]
    width: int = task_attributes["resolutionWidth"]
    height: int = task_attributes["resolutionHeight"]
    pixel_aspect: float = task_attributes["pixelAspect"]
    if renderer == "arnold":
        # set renderer settings for Arnold from project settings
        self._set_arnold_settings()

    if renderer == "vray":
        self._set_vray_settings(width, height, pixel_aspect, aov_separator)

    if renderer == "redshift":
        self._set_redshift_settings()
        mel.eval("redshiftUpdateActiveAovList")

    if renderer == "renderman":
        image_dir = self._image_dir["renderman"]
        cmds.setAttr("rmanGlobals.imageOutputDir",
                     image_dir, type="string")
        self._set_renderman_settings(aov_separator)
    self._set_default_render_resolution(width, height, pixel_aspect)