BPathForeachPathData Struct Reference

#include <BKE_bpath.hh>

Public Attributes
Main *	bmain
BPathForeachPathFunctionCallback	callback_function
eBPathForeachFlag	flag
void *	user_data
const char *	absolute_base_path
ID *	owner_id
bool	is_path_modified

Detailed Description

Storage for common data needed across the BPath 'foreach_path' code.

Definition at line 98 of file BKE_bpath.hh.

Member Data Documentation

absolute_base_path

const char* BPathForeachPathData::absolute_base_path

The root to use as base for relative paths. Only set if BKE_BPATH_FOREACH_PATH_ABSOLUTE flag is set, NULL otherwise.

Definition at line 112 of file BKE_bpath.hh.

Referenced by BKE_bpath_foreach_path_allocated_process(), BKE_bpath_foreach_path_dirfile_fixed_process(), BKE_bpath_foreach_path_fixed_process(), and BKE_bpath_foreach_path_id().

bmain

Main* BPathForeachPathData::bmain

Definition at line 99 of file BKE_bpath.hh.

Referenced by BKE_bpath_foreach_path_id(), BKE_bpath_foreach_path_main(), BKE_bpath_list_backup(), BKE_bpath_list_restore(), BKE_bpath_missing_files_check(), BKE_bpath_missing_files_find(), BKE_bpath_relative_rebase(), bpath_absolute_relative_convert(), bpy_blend_paths(), bpy_file_path_foreach(), bpy_file_path_map(), clean_paths(), image_foreach_path(), and library_foreach_path().

callback_function

BPathForeachPathFunctionCallback BPathForeachPathData::callback_function

Definition at line 101 of file BKE_bpath.hh.

Referenced by BKE_bpath_foreach_path_allocated_process(), BKE_bpath_foreach_path_dirfile_fixed_process(), BKE_bpath_foreach_path_fixed_process(), BKE_bpath_list_backup(), BKE_bpath_list_restore(), BKE_bpath_missing_files_check(), BKE_bpath_missing_files_find(), BKE_bpath_relative_rebase(), bpath_absolute_relative_convert(), bpy_blend_paths(), bpy_file_path_foreach(), bpy_file_path_map(), and clean_paths().

flag

eBPathForeachFlag BPathForeachPathData::flag

Definition at line 102 of file BKE_bpath.hh.

Referenced by BKE_bpath_foreach_path_id(), BKE_bpath_list_backup(), BKE_bpath_list_restore(), BKE_bpath_missing_files_check(), BKE_bpath_missing_files_find(), BKE_bpath_relative_rebase(), bpath_absolute_relative_convert(), bpy_blend_paths(), bpy_file_path_foreach(), bpy_file_path_map(), clean_paths(), image_foreach_path(), sound_foreach_path(), strip_foreach_path_callback(), vfont_foreach_path(), and volume_foreach_path().

is_path_modified

bool BPathForeachPathData::is_path_modified

IDTypeInfo callbacks are responsible to set this boolean if they modified one or more paths.

Definition at line 120 of file BKE_bpath.hh.

Referenced by BKE_bpath_foreach_path_allocated_process(), BKE_bpath_foreach_path_dirfile_fixed_process(), BKE_bpath_foreach_path_fixed_process(), and BKE_bpath_foreach_path_id().

owner_id

ID* BPathForeachPathData::owner_id

ID owning the path being processed.

Definition at line 115 of file BKE_bpath.hh.

Referenced by absolute_convert_foreach_path_cb(), BKE_bpath_foreach_path_id(), check_missing_files_foreach_path_cb(), foreach_id_file_path_foreach_callback(), foreach_id_file_path_map_callback(), and relative_convert_foreach_path_cb().

user_data

void* BPathForeachPathData::user_data

Definition at line 104 of file BKE_bpath.hh.

Referenced by absolute_convert_foreach_path_cb(), BKE_bpath_list_backup(), BKE_bpath_list_restore(), BKE_bpath_missing_files_check(), BKE_bpath_missing_files_find(), BKE_bpath_relative_rebase(), bpath_absolute_relative_convert(), bpath_list_append(), bpath_list_restore(), bpy_blend_foreach_path_cb(), bpy_blend_paths(), bpy_file_path_foreach(), bpy_file_path_map(), check_missing_files_foreach_path_cb(), clean_paths(), blender::ed::asset::external_file_check_callback(), foreach_id_file_path_foreach_callback(), foreach_id_file_path_map(), foreach_id_file_path_map_callback(), lib_id_library_local_paths_callback(), missing_files_find_foreach_path_cb(), relative_convert_foreach_path_cb(), and relative_rebase_foreach_path_cb().

---

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

• BKE_bpath.hh