unreal.RenderGridQueue

class unreal.RenderGridQueue(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

This class is responsible for rendering the given render grid jobs.

C++ Source:

• Plugin: RenderGrid

• Module: RenderGrid

• File: RenderGridQueue.h

add_job(job) → None

Queues the given job.

Parameters:

job (RenderGridJob) –

cancel() → None

Cancels the current and the remaining queued jobs. Relies on the internal movie pipeline implementation of job canceling on whether this will stop the current render grid job from rendering or not. Will always prevent new render grid jobs from rendering.

classmethod close_editor_on_completion() → None

Call this function to make it so that the editor will be closed when all rendering queues have finished. This function has to only be called once.

generate_new_guid() → None

Randomly generates a new GUID.

get_currently_rendering_job() → RenderGridJob

Retrieves the currently rendering render grid job, can return NULL.

Return type:

RenderGridJob

classmethod get_currently_rendering_queue() → RenderGridQueue

Returns the currently rendering queue, or NULL if there isn’t any currently rendering.

Return type:

RenderGridQueue

get_guid() → Guid

Returns the GUID, which is randomly generated at creation.

Return type:

Guid

get_job_status(job) → str

Retrieves the rendering status of the given render grid job. Will return an empty string if this job wasn’t found in this queue.

Parameters:

job (RenderGridJob) –

Return type:

str

get_job_status_percentage(job) → float

Returns the percentage of the rendering status of the given render grid job. Will return 0 if this job wasn’t found in this queue.

Parameters:

job (RenderGridJob) –

Return type:

float

get_jobs() → Array[RenderGridJob]

Returns all the jobs that have been and will be rendered.

Return type:

Array[RenderGridJob]

get_jobs_completed_count() → int32

Returns the number of jobs that have finished rendering. Basically just returns [Get Jobs Count] minus [Get Jobs Remaining Count].

Return type:

int32

get_jobs_count() → int32

Returns the number of jobs that have been and will be rendered.

Return type:

int32

get_jobs_remaining_count() → int32

Returns the number of jobs that are still left to render, includes the job that is currently rendering.

Return type:

int32

classmethod get_remaining_rendering_queues_count() → int32

Returns the number of rendering queues that are currently queued up. This also includes the currently rendering queue.

Return type:

int32

get_render_grid() → RenderGrid

Retrieves the rendering status of the given render grid job.

Return type:

RenderGrid

get_status() → str

Returns the status of the rendering process.

Return type:

str

get_status_percentage() → float

Returns the percentage of jobs finished, this includes the progression of the job that is currently rendering.

Return type:

float

is_canceled() → bool

Returns true if this queue has been canceled.

Return type:

bool

is_currently_rendering() → bool

Returns true if this queue is the one that’s currently rendering, returns false if it hasn’t started yet, or if it’s waiting in the queue, or if it has finished.

Return type:

bool

is_finished() → bool

Returns true if this queue has been canceled.

Return type:

bool

is_paused() → bool

Returns true if this queue is currently paused.

Return type:

bool

is_started() → bool

Returns true if this queue has been started.

Return type:

bool

pause() → None

Pauses the queue.

resume() → None

Resumes the queue.

to_debug_string() → str

Obtains a string representation of this object. Shouldn’t be used for anything other than logging/debugging.

Return type:

str