blendgen.session

Public symbols exposed by blendgen.session.

Session

Class source

class Session

A session wrapper class used to manage dataset creation

Session.__init__

Method source

def __init__(self, renderer=None, dataset=None, output_dir=f'{getcwd()}/data/toy_dataset/', frame_start=0, frame_length=1, passes=None, on_before_new_frame=None, on_after_new_frame=None, on_start=None, on_complete=None)

Creates a session wrapper class used for a rendering session

Keyword Arguments: renderer {Renderer} -- BlendGen Renderer instace (default: {None}) dataset {Dataset} -- BlendGen Dataset instace (default: {None}) output_dir {str} -- Dataset base path (default: {"data/toy_dataset/"}) frame_length {int} -- Length of sequence to render (default: {1}) passes {list} -- A list of render passes (default: {None}) on_before_new_frame {function} -- Callback called before a new frame is rendered (default: {None}) on_after_new_frame {function} -- Callback called after a new frame is rendered (default: {None}) on_start {function} -- Callback called before a dataset is rendered (default: {None}) on_complete {function} -- Callback called after a dataset is rendered (default: {None})

Session.run

Method source

def run(self)

Run the session and capture the dataset

Session.update

Method source

def update(self)

Force-update data blocks, replacing Blender 2.7's scene.update.

Session.on_complete

Property source

def on_complete(self)

Getter for the on complete callback

Returns: :function: -- The function assigned or None

Session.on_start

Property source

def on_start(self)

Getter for the on start callback

Returns: :function: -- The function assigned or None

Session.on_before_new_frame

Property source

def on_before_new_frame(self)

Getter for the on before a new frame is rendered callback

Returns: :function: -- The function assigned or None

Session.on_after_new_frame

Property source

def on_after_new_frame(self)

Getter for the on after a new frame is rendered callback

Returns: :function: -- The function assigned or None

Session.on_complete.setter

Setter source

def on_complete(self, callback)

A setter for the on complete callback

Arguments: callback {function} -- The callback to call when completed

Session.on_start.setter

Setter source

def on_start(self, callback)

A setter for the on start callback

Arguments: callback {function} -- The callback to call when started

Session.on_before_new_frame.setter

Setter source

def on_before_new_frame(self, callback)

A setter for the on new frame callback

Arguments: callback {function} -- The callback to call before every new frame

Session.on_after_new_frame.setter

Setter source

def on_after_new_frame(self, callback)

A setter for the after new frame callback

Arguments: callback {function} -- The callback to call after every new frame

Session.info

Property source

def info(self)

Get a pretty printed ASCII table with the session info

Returns: str -- The ASCII table string