Blender: blender::ed::asset::list::AssetList Class Reference

Blender V4.5

Inherits blender::NonCopyable.

Public Member Functions
	AssetList ()=delete

	AssetList (AssetList &&other)=default

	~AssetList ()=default

void	iterate (AssetListIterFn fn) const

Asset list API
Internally re-uses FileList from the File Browser. It does all the heavy lifting already.
	AssetList (eFileSelectType filesel_type, const AssetLibraryReference &asset_library_ref)

void	setup ()

void	fetch (const bContext &C)

void	ensure_blocking (const bContext &C)

void	clear (wmWindowManager *wm)

void	clear_current_file_assets (wmWindowManager *wm)

AssetHandle	asset_get_by_index (int index) const

bool	needs_refetch () const

bool	is_loaded () const

asset_system::AssetLibrary *	asset_library () const

void	iterate (AssetListIndexIterFn fn) const

int	size () const

void	tag_main_data_dirty () const

void	remap_id (ID id_old, ID id_new) const

static bool	listen (const wmNotifier &notifier)

Detailed Description

Definition at line 83 of file asset_list.cc.

Constructor & Destructor Documentation

◆ AssetList() [1/3]

blender::ed::asset::list::AssetList::AssetList ( )

delete

◆ AssetList() [2/3]

blender::ed::asset::list::AssetList::AssetList	(	eFileSelectType	filesel_type,
		const AssetLibraryReference &	asset_library_ref )

Definition at line 113 of file asset_list.cc.

◆ AssetList() [3/3]

blender::ed::asset::list::AssetList::AssetList ( AssetList && other )

default

◆ ~AssetList()

blender::ed::asset::list::AssetList::~AssetList ( )

default

Member Function Documentation

◆ asset_get_by_index()

AssetHandle blender::ed::asset::list::AssetList::asset_get_by_index ( int index ) const

Definition at line 260 of file asset_list.cc.

References filelist_file().

◆ asset_library()

asset_system::AssetLibrary * blender::ed::asset::list::AssetList::asset_library ( ) const

Definition at line 193 of file asset_list.cc.

References filelist_asset_library().

◆ clear()

void blender::ed::asset::list::AssetList::clear ( wmWindowManager * wm )

Definition at line 233 of file asset_list.cc.

References filelist_clear(), filelist_freelib(), filelist_readjob_stop(), filelist_tag_force_reset(), NC_ASSET, ND_ASSET_LIST, and WM_main_add_notifier().

Referenced by blender::ed::asset::list::clear().

◆ clear_current_file_assets()

void blender::ed::asset::list::AssetList::clear_current_file_assets ( wmWindowManager * wm )

Definition at line 246 of file asset_list.cc.

References filelist_clear_from_reset_tag(), filelist_freelib(), filelist_readjob_stop(), filelist_tag_force_reset_mainfiles(), filelist_tag_reload_asset_library(), NC_ASSET, ND_ASSET_LIST, and WM_main_add_notifier().

Referenced by blender::ed::asset::list::clear().

◆ ensure_blocking()

void blender::ed::asset::list::AssetList::ensure_blocking ( const bContext & C )

Definition at line 167 of file asset_list.cc.

References filelist_clear_from_reset_tag(), filelist_filter(), filelist_needs_force_reset(), filelist_needs_reading(), filelist_readjob_blocking_run(), filelist_sort(), NC_ASSET, and ND_ASSET_LIST_READING.

◆ fetch()

void blender::ed::asset::list::AssetList::fetch ( const bContext & C )

Definition at line 149 of file asset_list.cc.

References CTX_wm_manager(), filelist_clear_from_reset_tag(), filelist_filter(), filelist_needs_force_reset(), filelist_needs_reading(), filelist_pending(), filelist_readjob_start(), filelist_readjob_stop(), filelist_sort(), NC_ASSET, and ND_ASSET_LIST_READING.

◆ is_loaded()

bool blender::ed::asset::list::AssetList::is_loaded ( ) const

Definition at line 188 of file asset_list.cc.

References filelist_is_ready().

◆ iterate() [1/2]

void blender::ed::asset::list::AssetList::iterate ( AssetListIndexIterFn fn ) const

Definition at line 198 of file asset_list.cc.

References filelist_entry_get_asset_representation(), and filelist_files_ensure().

◆ iterate() [2/2]

void blender::ed::asset::list::AssetList::iterate ( AssetListIterFn fn ) const

◆ listen()

bool blender::ed::asset::list::AssetList::listen ( const wmNotifier & notifier )

static

Returns: True if the asset-list needs a UI redraw.

Definition at line 268 of file asset_list.cc.

References wmNotifier::action, wmNotifier::category, wmNotifier::data, ELEM, NA_ADDED, NA_EDITED, NA_REMOVED, NA_RENAME, NC_ASSET, NC_ID, ND_ASSET_LIST, ND_ASSET_LIST_PREVIEW, and ND_ASSET_LIST_READING.

Referenced by blender::ed::asset::list::listen().

◆ needs_refetch()

bool blender::ed::asset::list::AssetList::needs_refetch ( ) const

Definition at line 183 of file asset_list.cc.

References filelist_needs_force_reset(), and filelist_needs_reading().

◆ remap_id()

void blender::ed::asset::list::AssetList::remap_id	(	ID *	id_old,
		ID *	id_new ) const

Definition at line 305 of file asset_list.cc.

References tag_main_data_dirty().

◆ setup()

void blender::ed::asset::list::AssetList::setup ( )

Definition at line 118 of file asset_list.cc.

References AS_asset_library_root_path_from_library_ref(), blender::ed::asset::index::file_indexer_asset, file_indexer_noop, FILE_MAX_LIBEXTRA, FILE_SELECT_MAX_RECURSIONS, FILE_SORT_ASSET_CATALOG, FILE_TYPE_BLENDERLIB, filelist_setdir(), filelist_setfilter_options(), filelist_setindexer(), filelist_setlibrary(), filelist_setrecursion(), filelist_setsorting(), FILTER_ID_ALL, STRNCPY(), and USER_EXPERIMENTAL_TEST.

◆ size()

int blender::ed::asset::list::AssetList::size ( ) const

Returns: The number of assets in the list.

Definition at line 293 of file asset_list.cc.

References filelist_files_ensure().

◆ tag_main_data_dirty()

void blender::ed::asset::list::AssetList::tag_main_data_dirty ( ) const

Definition at line 298 of file asset_list.cc.

References filelist_needs_reset_on_main_changes(), and filelist_tag_force_reset_mainfiles().

Referenced by remap_id(), and blender::ed::asset::list::storage_tag_main_data_dirty().

The documentation for this class was generated from the following file:

asset_list.cc