e5e8db73df
The main goal of this refactor is to make BPath module use `IDTypeInfo`, and move each ID-specific part of the `foreach_path` looper into their own IDTypeInfo struct, using a new `foreach_path` callback. Additionally, following improvements/cleanups are included: * Attempt to get better, more consistent namings. ** In particular, move from `path_visitor` to more standard `foreach_path`. * Update and extend documentation. ** API doc was moved to header, according to recent discussions on this topic. * Remove `BKE_bpath_relocate_visitor` from API, this is specific callback that belongs in `lib_id.c` user code. NOTE: This commit is expected to be 100% non-behavioral-change. This implies that several potential further changes were only noted as comments (like using a more generic solution for `lib_id_library_local_paths`, addressing inconsistencies like path of packed libraries always being skipped, regardless of the `BKE_BPATH_FOREACH_PATH_SKIP_PACKED` `eBPathForeachFlag` flag value, etc.). NOTE: basic unittests were added to master already in rBdcc500e5a265093bc9cc. Reviewed By: brecht Differential Revision: https://developer.blender.org/D13381
131 lines
3.3 KiB
C
131 lines
3.3 KiB
C
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*/
|
|
|
|
#include "DNA_defaults.h"
|
|
#include "DNA_object_types.h"
|
|
#include "DNA_sound_types.h"
|
|
#include "DNA_speaker_types.h"
|
|
|
|
#include "BLI_math.h"
|
|
#include "BLI_utildefines.h"
|
|
|
|
#include "BLT_translation.h"
|
|
|
|
#include "BKE_anim_data.h"
|
|
#include "BKE_idtype.h"
|
|
#include "BKE_lib_id.h"
|
|
#include "BKE_lib_query.h"
|
|
#include "BKE_main.h"
|
|
#include "BKE_speaker.h"
|
|
|
|
#include "BLO_read_write.h"
|
|
|
|
static void speaker_init_data(ID *id)
|
|
{
|
|
Speaker *speaker = (Speaker *)id;
|
|
|
|
BLI_assert(MEMCMP_STRUCT_AFTER_IS_ZERO(speaker, id));
|
|
|
|
MEMCPY_STRUCT_AFTER(speaker, DNA_struct_default_get(Speaker), id);
|
|
}
|
|
|
|
static void speaker_foreach_id(ID *id, LibraryForeachIDData *data)
|
|
{
|
|
Speaker *speaker = (Speaker *)id;
|
|
|
|
BKE_LIB_FOREACHID_PROCESS_IDSUPER(data, speaker->sound, IDWALK_CB_USER);
|
|
}
|
|
|
|
static void speaker_blend_write(BlendWriter *writer, ID *id, const void *id_address)
|
|
{
|
|
Speaker *spk = (Speaker *)id;
|
|
|
|
/* write LibData */
|
|
BLO_write_id_struct(writer, Speaker, id_address, &spk->id);
|
|
BKE_id_blend_write(writer, &spk->id);
|
|
|
|
if (spk->adt) {
|
|
BKE_animdata_blend_write(writer, spk->adt);
|
|
}
|
|
}
|
|
|
|
static void speaker_blend_read_data(BlendDataReader *reader, ID *id)
|
|
{
|
|
Speaker *spk = (Speaker *)id;
|
|
BLO_read_data_address(reader, &spk->adt);
|
|
BKE_animdata_blend_read_data(reader, spk->adt);
|
|
|
|
#if 0
|
|
spk->sound = newdataadr(fd, spk->sound);
|
|
direct_link_sound(fd, spk->sound);
|
|
#endif
|
|
}
|
|
|
|
static void speaker_blend_read_lib(BlendLibReader *reader, ID *id)
|
|
{
|
|
Speaker *spk = (Speaker *)id;
|
|
BLO_read_id_address(reader, spk->id.lib, &spk->sound);
|
|
}
|
|
|
|
static void speaker_blend_read_expand(BlendExpander *expander, ID *id)
|
|
{
|
|
Speaker *spk = (Speaker *)id;
|
|
BLO_expand(expander, spk->sound);
|
|
}
|
|
|
|
IDTypeInfo IDType_ID_SPK = {
|
|
.id_code = ID_SPK,
|
|
.id_filter = FILTER_ID_SPK,
|
|
.main_listbase_index = INDEX_ID_SPK,
|
|
.struct_size = sizeof(Speaker),
|
|
.name = "Speaker",
|
|
.name_plural = "speakers",
|
|
.translation_context = BLT_I18NCONTEXT_ID_SPEAKER,
|
|
.flags = IDTYPE_FLAGS_APPEND_IS_REUSABLE,
|
|
.asset_type_info = NULL,
|
|
|
|
.init_data = speaker_init_data,
|
|
.copy_data = NULL,
|
|
.free_data = NULL,
|
|
.make_local = NULL,
|
|
.foreach_id = speaker_foreach_id,
|
|
.foreach_cache = NULL,
|
|
.foreach_path = NULL,
|
|
.owner_get = NULL,
|
|
|
|
.blend_write = speaker_blend_write,
|
|
.blend_read_data = speaker_blend_read_data,
|
|
.blend_read_lib = speaker_blend_read_lib,
|
|
.blend_read_expand = speaker_blend_read_expand,
|
|
|
|
.blend_read_undo_preserve = NULL,
|
|
|
|
.lib_override_apply_post = NULL,
|
|
};
|
|
|
|
void *BKE_speaker_add(Main *bmain, const char *name)
|
|
{
|
|
Speaker *spk;
|
|
|
|
spk = BKE_id_new(bmain, ID_SPK, name);
|
|
|
|
return spk;
|
|
}
|