artellapipe.tools.lightrigsmanager.core.api module

API module to work with light rigs

artellapipe.tools.lightrigsmanager.core.api.get_config()

Returns artellapipe-tools-lightrigsmanager configuration file :return: ArtellaConfiguration

artellapipe.tools.lightrigsmanager.core.api.get_light_rig_file_type(config=None)

Returns file type used by light rigs in current project :param project: :param config: :return:

artellapipe.tools.lightrigsmanager.core.api.get_light_rig_file_type_instance(light_rig_name, light_rig_folder=None, project=None, config=None, light_rigs_path=None)

artellapipe.tools.lightrigsmanager.core.api.get_light_rigs_path(project=None, config=None)

Returns path where Light Rigs are located :param project: :param config: :return: str

artellapipe.tools.lightrigsmanager.core.api.import_light_rig(light_rig_name, light_rig_folder=None, project=None, config=None, light_rigs_path=None)

Imports light rig in current DCC scene :param light_rig_name: str :param light_rig_folder: str :param project: ArtellaProject :param config: ArtellaConfig :param light_rigs_path: str :return: bool

artellapipe.tools.lightrigsmanager.core.api.open_light_rig(light_rig_name, light_rig_folder=None, project=None, config=None, light_rigs_path=None)

Opens light rig in current DCC scene :param light_rig_name: str :param light_rig_folder: str :param project: ArtellaProject :param config: ArtellaConfig :param light_rigs_path: str :return: bool

artellapipe.tools.lightrigsmanager.core.api.reference_light_rig(light_rig_name, light_rig_folder=None, project=None, config=None, light_rigs_path=None)

References light rig in current DCC scene :param light_rig_name: str :param light_rig_folder: str :param project: ArtellaProject :param config: ArtellaConfig :param light_rigs_path: str :return: bool