Guía para configurar callbacks de render en Movie Render Graph de Unreal Engine

Movie Render Graph (MRG) de Unreal Engine 5.4 ofrece un sistema de callbacks para ejecutar tareas adicionales antes y después de los trabajos de render. Según la documentación oficial de Epic Games, estas tareas se pueden configurar mediante Execute Script Node, que se añade al gráfico. Esta guía explica el flujo básico de configuración para equipos que quieran realizar preparativos al iniciar un render, revisar los datos de salida cuando termina un trabajo o ejecutar acciones por plano.

¿Cuándo resultan útiles los callbacks?

Un callback es un código personalizado que se ejecuta en un punto determinado del flujo de render. Se pueden usar callbacks de trabajo para el inicio y el final de un trabajo, y callbacks de plano para el inicio y el final de cada plano. Por ejemplo, es posible revisar los datos de salida cuando termina un trabajo o procesar las rutas de archivo de un plano cuando este finaliza.

Execute Script Node de MRG permite incorporar callbacks a la configuración del gráfico. La clase del callback se deriva de MovieGraphScriptBase, de la API de Python de Unreal. Las funciones correspondientes se sobrescriben con @unreal.ufunction(override=True). Una vez registrada la clase del callback, se puede seleccionar en el menú de Execute Script Node.

1. Prepara el complemento Movie Render Queue y el gráfico

Primero, en Unreal Editor, ve a Edit > Plugins, activa el complemento Movie Render Queue en la sección Rendering y reinicia el editor. El proyecto debe incluir un Level Sequence que se vaya a renderizar.

Se accede a Movie Render Graph a través de Movie Render Queue. Este es el flujo descrito en la documentación de Epic:

1. Abre la ventana Movie Render Queue desde Window > Cinematics > Movie Render Queue.

2. Pulsa el botón de render y selecciona el Level Sequence correspondiente.

3. En el menú Unsaved Config de la columna Settings, selecciona Movie Render Graph (Beta).

4. En la sección Create New Asset, crea un Movie Render Graph, asígnale un nombre y guárdalo.

5. Abre y edita la configuración del gráfico creado desde la columna Settings.

En el flujo de trabajo actual, Movie Render Queue (MRQ) y Movie Render Graph se pueden usar conjuntamente. MRQ ofrece una interfaz para poner trabajos en cola y realizar renders por lotes, mientras que MRG permite configurar los procesos de render mediante un gráfico basado en nodos.

2. Crea una clase de callback de Python

El siguiente ejemplo muestra callbacks para el inicio y el final de un trabajo. La llamada a on_job_finished se ejecuta cuando termina el trabajo de render; puede usarse tanto si finaliza correctamente como si se cancela. El atributo success de la información del resultado permite comprobar si el trabajo se completó correctamente.

import unreal

@unreal.uclass()
class CallbackOverrides(unreal.MovieGraphScriptBase):
    @unreal.ufunction(override=True)
    def on_job_start(self, in_job_copy):
        super().on_job_start(in_job_copy)
        unreal.log("Render işi başlıyor")

    @unreal.ufunction(override=True)
    def on_job_finished(self, in_job_copy, in_output_data):
        super().on_job_finished(in_job_copy, in_output_data)
        unreal.log("Render işi tamamlandı veya iptal edildi")

En este ejemplo, se registra el inicio y el final del trabajo. Antes de añadir lógica propia, es importante tener claro en qué fase se ejecuta el callback y qué datos recibe. Las configuraciones del trabajo y del gráfico se pasan al callback como copias; por lo tanto, los cambios realizados dentro de este no modifican directamente el recurso original de la cola.

La clase debe registrarse para aparecer en el menú de Execute Script Node. En el ejemplo de Epic, el registro de la clase se realiza para la sesión actual. Si se quiere que esté disponible cada vez que se abre el editor, se puede importar la clase desde uno de los archivos /Content/Python/init_unreal.py. Esto hace que la clase se cargue al iniciar el editor.

3. Elige entre callbacks de trabajo y de plano

on_job_start se ejecuta cuando empieza un trabajo de render; on_job_finished, cuando termina. Si un Level Sequence contiene varios planos, se pueden usar on_shot_start y on_shot_finished por separado para cada uno. El callback de inicio del plano se ejecuta antes de que este se configure. El callback de finalización del plano recibe los datos de salida de ese plano.

Hay dos formas de activar los callbacks por plano: marcar la opción Flush Disk Writes Per Shot en Global Output Settings Node del gráfico o sobrescribir la función is_per_shot_callback_needed en la clase y hacer que devuelva True. No actives esta opción sin valorar sus consecuencias: Epic señala que puede aumentar el tiempo de render, ya que espera a que los archivos se escriban en el disco.

¿Qué aporta a los flujos de trabajo de arquitectura y archviz?

Los equipos de visualización que ponen en cola varios planos o escenas pueden incorporar tareas repetitivas al flujo de render mediante callbacks a nivel de trabajo y de plano. Acceder a los datos de salida y a las rutas de archivo cuando termina un trabajo sienta las bases para dirigir, por ejemplo, los archivos generados por los planos a una etapa posterior de procesamiento. Sin embargo, la documentación no describe un estándar específico para nombrar archivos ni una automatización de archviz lista para usar; esta lógica debe desarrollarse según las necesidades del proyecto.

Si se busca integrar el flujo con una render farm u otro proceso, también son importantes las opciones de render local y en un proceso independiente de MRQ. Para renderizar en un proceso independiente, los cambios del proyecto deben estar guardados. Comprueba los callbacks en un trabajo de prueba pequeño antes de usar la configuración de entrega real; en especial, verifica el efecto de la opción de escritura en disco por plano sobre la duración y que la clase se cargue al iniciar el editor.

Errores frecuentes

• Olvidar reiniciar el editor después de activar el complemento Movie Render Queue.

• Dar por hecho que los callbacks por plano se ejecutarán automáticamente; también hay que activar el requisito de escritura en disco por plano.

• Interpretar que la finalización del trabajo significa únicamente que el render se completó correctamente. El callback también puede ejecutarse si se cancela; comprueba la información de éxito.

• Suponer que los cambios realizados en la copia del trabajo o de la configuración del gráfico dentro del callback actualizan el recurso original de la cola.

• Pasar por alto que esperar a que se escriban los archivos al final de cada plano puede alargar el tiempo de render.