unreal.RenderGridJob
¶
- class unreal.RenderGridJob(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
Object
This class represents a render grid job, in other words, an entry (a row) of a render grid. It contains a level sequence and custom properties that will be applied while rendering.
Each RenderGridJob must belong to a RenderGrid.
C++ Source:
Plugin: RenderGrid
Module: RenderGrid
File: RenderGrid.h
Editor Properties: (see get_editor_property/set_editor_property)
custom_end_frame
(int32): [Read-Write] If bOverrideEndFrame is true, this property will override the end frame of the level sequence.custom_resolution
(IntPoint): [Read-Write] If bOverrideResolution is true, this property will override the resolution of the render.custom_start_frame
(int32): [Read-Write] If bOverrideStartFrame is true, this property will override the start frame of the level sequence.level_sequence
(LevelSequence): [Read-Write] The level sequence, this is what will be rendered during rendering. A job without a level sequence can’t be rendered.override_end_frame
(bool): [Read-Write] If this is true, the CustomEndFrame property will override the end frame of the level sequence.override_resolution
(bool): [Read-Write] If this is true, the CustomResolution property will override the resolution of the render.override_start_frame
(bool): [Read-Write] If this is true, the CustomStartFrame property will override the start frame of the level sequence.wait_frames_before_rendering
(int32): [Read-Write] Waits the given number of frames before it will render this job. This can be set to a higher amount when the renderer has to wait for your code to complete (such as construction scripts etc). Try increasing this value when rendering doesn’t produce the output you expect it to.
- get_custom_end_frame() int32 ¶
Get Custom End Frame
- Return type:
int32
- get_custom_start_frame() int32 ¶
Get Custom Start Frame
- Return type:
int32
- get_duration() -> (success=bool, duration=double)¶
Gets the calculated duration in seconds, if possible.
- Returns:
success (bool):
duration (double):
- Return type:
tuple
- get_end_frame() -> (success=bool, end_frame=int32)¶
Gets the calculated end frame, if possible.
- Returns:
success (bool):
end_frame (int32):
- Return type:
tuple
- get_end_time() -> (success=bool, end_time=double)¶
Gets the calculated end time, if possible.
- Returns:
success (bool):
end_time (double):
- Return type:
tuple
- get_level_sequence() LevelSequence ¶
Get Level Sequence
- Return type:
- get_output_aspect_ratio() double ¶
Gets the aspect ratio that this job will be rendered in.
- Return type:
double
- get_output_resolution() IntPoint ¶
Gets the resolution that this job will be rendered in.
- Return type:
- get_remote_control_field_id_from_label(label) Guid or None ¶
Get Remote Control Field Id from Label
- get_remote_control_label_from_field_id(field_id) str or None ¶
Get Remote Control Label from Field Id
- get_remote_control_value(field_id) str or None ¶
Get Remote Control Value
- get_render_preset() MoviePipelinePrimaryConfig ¶
Get Render Preset
- Return type:
- get_render_preset_output_settings() MoviePipelineOutputSetting ¶
Get Render Preset Output Settings
- Return type:
- get_start_frame() -> (success=bool, start_frame=int32)¶
Gets the calculated start frame, if possible.
- Returns:
success (bool):
start_frame (int32):
- Return type:
tuple
- get_start_time() -> (success=bool, start_time=double)¶
Gets the calculated start time, if possible.
- Returns:
success (bool):
start_time (double):
- Return type:
tuple
- get_wait_frames_before_rendering() int32 ¶
Get Wait Frames Before Rendering
- Return type:
int32
- matches_search_term(search_term) bool ¶
Checks whether the job contains data that matches the search terms.
- set_custom_end_frame(new_custom_end_frame) None ¶
Set Custom End Frame
- Parameters:
new_custom_end_frame (int32) –
- set_custom_resolution(new_custom_resolution) None ¶
Set Custom Resolution
- Parameters:
new_custom_resolution (IntPoint) –
- set_custom_start_frame(new_custom_start_frame) None ¶
Set Custom Start Frame
- Parameters:
new_custom_start_frame (int32) –
- set_is_using_custom_end_frame(new_override_end_frame) None ¶
Set Is Using Custom End Frame
- Parameters:
new_override_end_frame (bool) –
- set_is_using_custom_resolution(new_override_resolution) None ¶
Set Is Using Custom Resolution
- Parameters:
new_override_resolution (bool) –
- set_is_using_custom_start_frame(new_override_start_frame) None ¶
Set Is Using Custom Start Frame
- Parameters:
new_override_start_frame (bool) –
- set_level_sequence(new_sequence) None ¶
Set Level Sequence
- Parameters:
new_sequence (LevelSequence) –
- set_output_directory(new_output_directory) None ¶
Set Output Directory
- Parameters:
new_output_directory (str) –
- set_render_preset(new_render_preset) None ¶
Set Render Preset
- Parameters:
new_render_preset (MoviePipelinePrimaryConfig) –