blenderproc.python.modules.main.Module module

class blenderproc.python.modules.main.Module.Module(config)[source]

Bases: object

Configuration:

All of these values can be set per Module or of the global config defined in the main.Initializer:

{
  "module": "main.Initializer",
  "config":{
    "global": {
      "output_dir": "<args:X>"
    }
  }
}

If they are set globally all modules will inherit them, if there is no module defined key available.

Parameter Description Type
output_is_temp If True, all files created in this module will be written into the temp_dir. If False, the output_dir is used. bool
output_dir The path to a directory where all persistent output files should be stored. If it doesn’t exist, it is created automatically. Default: “”. string
avoid_output This mode is only used during debugging, when no output should be produced. Default: False bool
_default_init()[source]

These operations are called during all modules inits

_determine_output_dir(output_is_temp_default=True)[source]

Returns the directory where to store output file created by this module.

Parameters:output_is_temp_default – True, if the files created by this module should be temporary by default.
Returns:The output directory to use