XRFeitoriaBlender


class xrfeitoria.factory.XRFeitoriaBlender(engine_exec: str | Path | None = None, project_path: str | Path | None = None, background: bool = False, reload_rpc_code: bool = False, replace_plugin: bool = False, dev_plugin: bool = False, new_process: bool = False)[source]

Factory class contains all the classes and functions for Blender.

Members:

ObjectUtils: Object utilities.

Camera: Camera class.

Actor: Actor class.

Shape: Shape wrapper class.

Renderer: Renderer class.

sequence: Sequence wrapper function.

utils: Utilities functions executed in Blender.

render: Render jobs.

__init__(engine_exec: str | Path | None = None, project_path: str | Path | None = None, background: bool = False, reload_rpc_code: bool = False, replace_plugin: bool = False, dev_plugin: bool = False, new_process: bool = False) None[source]

Giving arguments to initialize.

Parameters:
  • new_process (bool, optional) – Whether to start Blender in a new process. Defaults to False.

  • exec_path (Optional[PathLike], optional) – Path to Blender executable. Defaults to None.

  • project_path (Optional[PathLike], optional) – Path to Blender project. Defaults to None.

  • background (bool, optional) – Whether to start Blender in background. Defaults to False.

  • reload_rpc_code (bool, optional) – whether to reload the registered rpc functions and classes. If you are developing the package or writing a custom remote function, set this to True to reload the code. This will only be in effect when new_process=False if the engine process is reused. Defaults to False.

  • replace_plugin (bool, optional) – Whether to replace the plugin. Defaults to False.

  • dev_plugin (bool, optional) – Whether to use the plugin under local directory. If False, would use the plugin downloaded from a remote server. Defaults to False.

  • cleanup (bool, optional) – Whether to clean up the scene. Defaults to True.