artellapipe.core.node module

Module that contains definitions for DCC nodes in Artella

class artellapipe.core.node.ArtellaAssetNode(project, node=None, **kwargs)

Bases: artellapipe.core.node.ArtellaDCCNode, object

property asset

Returns asset linked to this node :return: ArtellaAsset

property asset_path

Returns asset path :return: str

get_short_name(clean=False)

Returns the short name of the DCC node :param clean: bool :return: str

property name

Returns the name of the asset :return: str

class artellapipe.core.node.ArtellaDCCNode(project, node=None, update_at_init=True)

Bases: object

add_override(override_class=None)

Adds a new override to current asset node :param override_class: cls

property base_name

Returns the base name of the referenced file of DCC node :return: str

change_filename(new_filename)

Updates the filename that the current stored reference node is pointing to :param new_filename: str :return: str

change_namespace(new_namespace)

Updates the namespace of the reference stored node :param new_namespace: str :return: str

convert_reference_to_absolute_path()

Updates the current path the stored reference is pointing to from relative to absolute relative to the Artella Project path :return: str

property dir_name

Returns the directory name of the refernced file of DCC node :return: str

property exists

Returns whether current DCC node exists in DCC scene or not :return: bool

property filename

Returns filename of the referenced file of DCC node :return: str

get_overrides()

Returns overrides of the current asset node :return: list

get_tag_node()

Returns tag node associated to this Artella DCC node :return: ArtellaTagNode

has_override(override)

Returns current asset node already ahs given override or not :param override: ArtellaBaseOverride :return: bool

has_overrides()

Returns whether current node has overrides or not :return: bool

import_objects(with_absolute_path=False)

Import objects pointed by the stored reference node :param with_absolute_path: str, Whether the imported objects should be imported using a relative or an absolute path :return: str

property is_loaded

Returns whether DCC node exists is loaded or not :return: bool

property is_valid

Returns whether DCC node is valid or not :return: bool

property namespace

Returns namespace of the DCC node :return: str

property node

Returns DCC node :return: str

property nodes_list

Returns all children nodes of the DCC node :return: str

property parent_namespace

Returns the parent namespace of the DCC node :return: str

property project

Returns project attached to this node :return: ArtellaProject

remove()

remove_override(override_to_remove)

Removes given override from current asset node :param override_to_remove: variant, cls or ArtellaBaseOverride

save_all_overrides(save_path=None)

Stores all overrides to disk :param save_path: str :return:

save_override(override_to_save, save_path=None)

Exports given override to disk :param override_to_save: variant, cls or ArtellaBaseOverride :param save_path: str

update_info()

Updates the info of the current DCC node