Scene
Inherits from: ABC, _Serializable
Base class for describing rv scene. To set up a scene, implement generate function.
Methods
generate
Description:
Method to describe scene generation. To use framework you must implement it in a derrived class.
Signature:
@abstractmethod
def generate(self) -> NoneArguments:
Returns: None
set_resolution
Description:
Set resulting image resolution. If only width is passed, resulting image will be a square.
Signature:
def set_resolution(self, width: float, height: float=None)Arguments:
width:floatheight:float
Returns: Self
set_rendering_time_limit
Description:
Set the maximum allowed rendering time for a single image. Higher value leads to better quality.
Signature:
def set_rendering_time_limit(self, time_limit: float=3.0)Arguments:
time_limit:float— Rendering time limit in seconds
Returns: Self
set_passes
Description:
Set a list of render passes that will be saved when rendering.
Signature:
def set_passes(self, *passes: tuple[RenderPass | list[RenderPass], ...])Arguments:
*passes:tuple[RenderPass | list[RenderPass], ...]
Returns: Self
create_empty
Description:
Create an empty object. May be useful to point camera at or for debugging during preview stage.
Signature:
def create_empty(self, name: str='Empty') -> 'Object'Arguments:
name:str
Returns: 'Object'
create_sphere
Description:
Create a sphere primitive.
Signature:
def create_sphere(self, name: str='Sphere', radius: float=1.0, segments: int=32, ring_count: int=16) -> 'Object'Arguments:
name:strradius:floatsegments:intring_count:int
Returns: 'Object'
create_cube
Description:
Create a cube primitive.
Signature:
def create_cube(self, name: str='Cube', size: float=2.0) -> 'Object'Arguments:
name:strsize:float
Returns: 'Object'
create_plane
Description:
Create a plane primitive.
Signature:
def create_plane(self, name: str='Plane', size: float=2.0) -> 'Object'Arguments:
name:strsize:float
Returns: 'Object'
get_camera
Description:
Get the Camera object used for rendering.
Signature:
def get_camera(self) -> 'Camera'Arguments:
Returns: 'Camera'
set_world
Description:
Set a new World representing environmental lighting.
Signature:
def set_world(self, world: 'World') -> 'World'Arguments:
world:'World'
Returns: Self
get_world
Description:
Get current used World.
Signature:
def get_world(self) -> 'World'Arguments:
Returns: 'World'
set_tags
Description:
Set scene’s global tags.
Tags are used to represent image class for training a computer vision model for a classification task.
Signature:
def set_tags(self, *tags) -> 'Scene'Arguments:
*tags
Returns: Self
add_tags
Description:
Add tags to the scene.
Tags are used to represent image class for training a computer vision model for a classification task.
Signature:
def add_tags(self, *tags) -> 'Scene'Arguments:
*tags
Returns: Self
load_object
Description:
Get a loader object to import from a blender file.
If import_name is specified, it imports an object with specified name.
If no import_name is specified, it imports the first object.
Loader object is used to create instances of an object.
Signature:
def load_object(self, blendfile: str, import_name: str=None) -> 'ObjectLoader'Arguments:
blendfile:strimport_name:str
Returns: 'ObjectLoader'
load_objects
Description:
Get a list of loader objects to import from a blender file.
If import_names is specified, it imports only specified objects.
If no import_names is specified, it imports all specfied objects.
Loader object is used to create instances of an object.
Signature:
def load_objects(self, blendfile: str, import_names: list[str]=None) -> list['ObjectLoader']Arguments:
blendfile:strimport_names:list[str]
Returns: Self
Attributes
resolution
Type: tuple[int, int]
time_limit
Type: float
passes
Type: set[RenderPass]
output_dir
Type: Optional[str]
Directory for storing all outputs generated by a single rv render run
subdir
Type: str
Directory to store results of a single rendering
camera
Type: 'Camera'
world
Type: 'World'
tags
Type: set[str]
objects
Type: set['Object']
object_index_counter
Type: int