Skip to content

lib_rendersettings

RenderSettings

Bases: object

Source code in client/ayon_max/api/lib_rendersettings.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
 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
class RenderSettings(object):

    log = Logger.get_logger("RenderSettings")

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

    def __init__(self, project_settings=None):
        """
        Set up the naming convention for the render
        elements for the deadline submission
        """

        self._project_settings = project_settings
        if not self._project_settings:
            self._project_settings = get_project_settings(
                get_current_project_name()
            )

    def set_render_camera(self, selection):
        for sel in selection:
            # to avoid Attribute Error from pymxs wrapper
            if rt.classOf(sel) in rt.Camera.classes:
                rt.viewport.setCamera(sel)
                return
        raise RuntimeError("Active Camera not found")

    def render_output(self, container):
        # hard-coded, should be customized in the setting
        file = rt.maxFileName
        # hard-coded, set the renderoutput path
        setting = self._project_settings
        render_folder = get_default_render_folder(setting)
        filename, _ = os.path.splitext(file)
        output_dir = os.path.join(render_folder, filename)
        if not os.path.exists(output_dir):
            os.makedirs(output_dir)
        # hard-coded, should be customized in the setting
        folder_attributes = get_current_folder_entity()["attrib"]

        # get project resolution
        width = folder_attributes.get("resolutionWidth")
        height = folder_attributes.get("resolutionHeight")
        # Set Frame Range
        frame_start = folder_attributes.get("frame_start")
        frame_end = folder_attributes.get("frame_end")
        set_render_frame_range(frame_start, frame_end)
        # get the production render
        renderer_class = get_current_renderer()
        renderer = str(renderer_class).split(":")[0]

        img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"]   # noqa
        output = os.path.join(output_dir, container)
        try:
            aov_separator = self._aov_chars[(
                self._project_settings["max"]
                                      ["RenderSettings"]
                                      ["aov_separator"]
            )]
        except KeyError:
            aov_separator = "."
        output_filename = f"{output}..{img_fmt}"
        output_filename = output_filename.replace("{aov_separator}",
                                                  aov_separator)
        multipass_enabled = get_multipass_setting(renderer, setting)
        if renderer == "VUE_File_Renderer":
            rt.rendOutputFilename = output_filename
            return
        # TODO: Finish the arnold render setup
        elif renderer == "Arnold":
            # We should remove this
            rt.rendOutputFilename = output_filename
            self.arnold_setup(output_dir, container, multipass_enabled)

        elif is_supported_renderer(renderer):
            rt.rendOutputFilename = output_filename
            self.render_element_layer(output, width, height, img_fmt)

        elif renderer.startswith("V_Ray_"):
            vr_settings = get_vray_settings(renderer)
            vr_settings.output_force32bit_3dsmax_vfb = True
            vr_settings.output_splitgbuffer = multipass_enabled
            if img_fmt == "exr":
                vr_settings.output_saverawfile = True
                vr_settings.output_rawfilename = f"{output}.{img_fmt}"

            if multipass_enabled:
                rt.rendOutputFilename = output_filename
                vr_settings.output_splitfilename = f"{output}.{img_fmt}"
            else:
                rt.rendOutputFilename = f"{output}_tmp..{img_fmt}"
            self.render_element_layer(output, width, height, img_fmt)
        # TODO: supports multipass for different renderers
        elif renderer == "Redshift_Renderer":
            rt.rendOutputFilename = output_filename
            rt.renderers.current.separateAovFiles = multipass_enabled

        # prevent rendering extra files when using V-Ray
        rt.rendSaveFile = True if not renderer.startswith("V_Ray_") else False

        rt.renderSceneDialog.update()

    def arnold_setup(self, output_dir, container, multipass_enabled):
        # get Arnold RenderView run in the background
        # for setting up renderable camera
        multipass = str(multipass_enabled).lower()
        arv = rt.MAXToAOps.ArnoldRenderView()
        render_camera = rt.viewport.GetCamera()
        if render_camera:
            arv.setOption("Camera", str(render_camera))

        # TODO: add AOVs and extension
        img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"]   # noqa
        # TODO: enhance this maxscript to make sure it supports separate AOVs
        # with Arnold drivers.
        setup_cmd = (
            f"""
        amw = MaxtoAOps.AOVsManagerWindow()
        amw.close()
        aovmgr = renderers.current.AOVManager
        aovmgr.drivers = #()
        aovmgr.outputPath = "{output_dir}"
        img_fmt = "{img_fmt}"
        if img_fmt == "png" then driver = ArnoldPNGDriver()
        if img_fmt == "jpg" then driver = ArnoldJPEGDriver()
        if img_fmt == "exr" then driver = ArnoldEXRDriver()
        if img_fmt == "tif" then driver = ArnoldTIFFDriver()
        if img_fmt == "tiff" then driver = ArnoldTIFFDriver()
        append aovmgr.drivers driver
        aovmgr.drivers[1].aov_list = #()
        aovmgr.drivers[1].filenameSuffix  = "{container}."
        if aovmgr.drivers[1] == ArnoldEXRDriver() then (
            aovmgr.drivers[1].multipart = {multipass})
            """)

        rt.execute(setup_cmd)
        arv.close()

    def render_element_layer(self, dir, width, height, ext):
        """For Renderers with render elements"""
        rt.renderWidth = width
        rt.renderHeight = height
        render_elem = rt.maxOps.GetCurRenderElementMgr()
        render_elem_num = render_elem.NumRenderElements()
        if render_elem_num < 0:
            return

        for i in range(render_elem_num):
            renderlayer_name = render_elem.GetRenderElement(i)
            target, renderpass = str(renderlayer_name).split(":")
            aov_name = f"{dir}_{renderpass}..{ext}"
            render_elem.SetRenderElementFileName(i, aov_name)

    def get_render_output(self, container, output_dir):
        output = os.path.join(output_dir, container)
        img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"]   # noqa
        output_filename = f"{output}..{img_fmt}"
        return output_filename

    def get_render_element(self):
        orig_render_elem = []
        render_elem = rt.maxOps.GetCurRenderElementMgr()
        render_elem_num = render_elem.NumRenderElements()
        if render_elem_num < 0:
            return

        for i in range(render_elem_num):
            render_element = render_elem.GetRenderElementFilename(i)
            orig_render_elem.append(render_element)

        return orig_render_elem

    def get_batch_render_elements(self, container,
                                  output_dir, camera):
        render_element_list = list()
        output = os.path.join(output_dir, container)
        render_elem = rt.maxOps.GetCurRenderElementMgr()
        render_elem_num = render_elem.NumRenderElements()
        if render_elem_num < 0:
            return
        img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"]   # noqa

        for i in range(render_elem_num):
            renderlayer_name = render_elem.GetRenderElement(i)
            target, renderpass = str(renderlayer_name).split(":")
            camera = camera.replace(":", "_")
            aov_name = f"{output}_{camera}_{renderpass}..{img_fmt}"
            render_element_list.append(aov_name)
        return render_element_list

    def get_batch_render_output(self, camera):
        target_layer_no = rt.batchRenderMgr.FindView(camera)
        target_layer = rt.batchRenderMgr.GetView(target_layer_no)
        return target_layer.outputFilename

    def batch_render_elements(self, camera):
        target_layer_no = rt.batchRenderMgr.FindView(camera)
        target_layer = rt.batchRenderMgr.GetView(target_layer_no)
        outputfilename = target_layer.outputFilename
        directory = os.path.dirname(outputfilename)
        render_elem = rt.maxOps.GetCurRenderElementMgr()
        render_elem_num = render_elem.NumRenderElements()
        if render_elem_num < 0:
            return
        ext = self._project_settings["max"]["RenderSettings"]["image_format"]   # noqa

        for i in range(render_elem_num):
            renderlayer_name = render_elem.GetRenderElement(i)
            target, renderpass = str(renderlayer_name).split(":")
            aov_name = f"{directory}_{camera}_{renderpass}..{ext}"
            render_elem.SetRenderElementFileName(i, aov_name)

    def batch_render_layers_by_multi_camera(self, container, output_dir, cameras):
        """Get the list of renderlayers for the multi-camera from batch render
        manager.

        Args:
            container (str): container name
            output_dir (str): output render directory
            cameras (list): Cameras to create render layers for.

        Returns:
            list: List of output filenames for the render layers
        """
        outputs = list()
        output = os.path.join(output_dir, container)
        img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"]   # noqa
        for cam in cameras:
            camera = rt.getNodeByName(cam)
            layer_no = rt.batchRenderMgr.FindView(cam)
            renderlayer = None
            if layer_no == 0:
                renderlayer = rt.batchRenderMgr.CreateView(camera)
            else:
                renderlayer = rt.batchRenderMgr.GetView(layer_no)
            # use camera name as renderlayer name
            renderlayer.name = cam
            cam = cam.replace(":", "_")
            renderlayer.outputFilename = f"{output}_{cam}..{img_fmt}"
            outputs.append(renderlayer.outputFilename)
        return outputs

__init__(project_settings=None)

Set up the naming convention for the render elements for the deadline submission

Source code in client/ayon_max/api/lib_rendersettings.py
51
52
53
54
55
56
57
58
59
60
61
def __init__(self, project_settings=None):
    """
    Set up the naming convention for the render
    elements for the deadline submission
    """

    self._project_settings = project_settings
    if not self._project_settings:
        self._project_settings = get_project_settings(
            get_current_project_name()
        )

batch_render_layers_by_multi_camera(container, output_dir, cameras)

Get the list of renderlayers for the multi-camera from batch render manager.

Parameters:

Name Type Description Default
container str

container name

required
output_dir str

output render directory

required
cameras list

Cameras to create render layers for.

required

Returns:

Name Type Description
list

List of output filenames for the render layers

Source code in client/ayon_max/api/lib_rendersettings.py
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
def batch_render_layers_by_multi_camera(self, container, output_dir, cameras):
    """Get the list of renderlayers for the multi-camera from batch render
    manager.

    Args:
        container (str): container name
        output_dir (str): output render directory
        cameras (list): Cameras to create render layers for.

    Returns:
        list: List of output filenames for the render layers
    """
    outputs = list()
    output = os.path.join(output_dir, container)
    img_fmt = self._project_settings["max"]["RenderSettings"]["image_format"]   # noqa
    for cam in cameras:
        camera = rt.getNodeByName(cam)
        layer_no = rt.batchRenderMgr.FindView(cam)
        renderlayer = None
        if layer_no == 0:
            renderlayer = rt.batchRenderMgr.CreateView(camera)
        else:
            renderlayer = rt.batchRenderMgr.GetView(layer_no)
        # use camera name as renderlayer name
        renderlayer.name = cam
        cam = cam.replace(":", "_")
        renderlayer.outputFilename = f"{output}_{cam}..{img_fmt}"
        outputs.append(renderlayer.outputFilename)
    return outputs

render_element_layer(dir, width, height, ext)

For Renderers with render elements

Source code in client/ayon_max/api/lib_rendersettings.py
182
183
184
185
186
187
188
189
190
191
192
193
194
195
def render_element_layer(self, dir, width, height, ext):
    """For Renderers with render elements"""
    rt.renderWidth = width
    rt.renderHeight = height
    render_elem = rt.maxOps.GetCurRenderElementMgr()
    render_elem_num = render_elem.NumRenderElements()
    if render_elem_num < 0:
        return

    for i in range(render_elem_num):
        renderlayer_name = render_elem.GetRenderElement(i)
        target, renderpass = str(renderlayer_name).split(":")
        aov_name = f"{dir}_{renderpass}..{ext}"
        render_elem.SetRenderElementFileName(i, aov_name)

is_supported_renderer(renderer_name)

Whether ayon-max supports the relevant renderer.

Source code in client/ayon_max/api/lib_rendersettings.py
34
35
36
37
38
def is_supported_renderer(renderer_name: str) -> bool:
    """Whether ayon-max supports the relevant renderer."""
    if renderer_name in SUPPORTED_RENDERERS:
        return True
    return False