artellapipe.managers.shaders module

Module that contains manager to handle shaders

class artellapipe.managers.shaders.ShadersManager

Bases: object

property config

export_asset_shaders(asset, comment=None, new_version=False, shader_swatch=None, shaders_to_export=None)

Exports all shaders of the given asset :param asset: ArtellaAsset :param publish: bool :param comment: str, publish comment :param new_version: bool :param shaders_to_export: list(str) :return: bool

export_asset_shaders_mapping(asset, comment=None, new_version=False)

Exports shaders mapping of the given asset :param asset: ArtellaAsset :param publish: bool :param comment: str :param new_version: bool :return: bool

export_shader(shader_name, export_path=None, comment=None, new_version=False, shader_swatch=None, asset=None)

Exports shaders :param shader_name: str, name of the shader to export :param export_path: str, path where shader file will be exported into (optional) :param comment: str, publish comment :param shader_swatch: str, path where shader file will be exported into (optional) :return:

export_shaders(shaders_names, export_path=None, comment=None, new_version=False, asset=None, shader_swatch=None)

Exports all given shader names from current scene :param shaders_names: list(str) :param export_path: STR :param publish: bool :param comment: str :param new_version: bool :param asset: ArtellaAsset :param shader_swatch: :return: list

get_asset_shader_file_class()

Returns asset shader file class associated to this asset :return: class

get_asset_shaders(asset, return_only_shaders=True, skip_standard_shaders=True)

Returns list of shaders applied to the given asset :param asset: list of dict

get_asset_shaders_to_export(asset, return_only_shaders=True, skip_standard_shaders=True)

Returns a list shaders that should be exported :param asset: :param return_only_shaders: :param skip_standard_shaders: :return:

get_shader_file(shader_name, shader_path=None, asset=None)

Returns shader file with given name (if exists) :param shader_name: str :param shader_path: str :param asset: str :return:

get_shader_file_class()

Returns shader file class associated to this asset :return: class

get_shader_path(shader_name)

Returns shader path with given name (if exists) :param shader_name: str :return: str

get_shaders_asset_file_type()

Returns file type used to define asset shaders :return: str

get_shaders_extensions()

Returns extension used for shaders in current project :return: str

get_shaders_path_file_type()

Returns file type used to define shaders :return: str

get_shaders_paths()

Returns path where shaders are located in the project :return: str

load_asset_shaders(asset_node, apply_shaders=True, status='published')

Loads all the shaders of the given asset :param asset_node: :param apply_shaders: bool :param status:

load_scene_shaders(status='published', apply_shaders=True)

Loads all shaders of the current assets in the scene :param status: :param apply_shaders: bool :return:

load_shader(shader_name, shader_path=None, asset=None, apply=True, status='working')

Loads shader with given name in current DCC :param shader_name: str :param apply: bool

unload_asset_shaders(asset_node)

Unload shaders of given asset :param asset_node: :param status: :return:

unload_shaders(asset_nodes=None)

Unload shaders applied to assets loaded in current DCC scene or to given ones :param assets:

update_shaders(shaders_paths=None)

Updates shaders from Artella