Blender V5.3
BKE_anim_data.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2009 Blender Authors, Joshua Leung. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
11#include <optional>
12
13#include "BLI_function_ref.hh"
14#include "BLI_string_ref.hh"
15
16namespace blender {
17
18struct AnimData;
19struct BlendDataReader;
20struct BlendWriter;
21struct FCurve;
22struct ID;
23struct Library;
25struct Main;
26struct ReportList;
27struct bAction;
28
29/* ************************************* */
30/* AnimData API */
31
49
53bool id_type_can_have_animdata(short id_type);
54bool id_can_have_animdata(const ID *id);
55
60
65
78bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act);
79
81
85void BKE_animdata_free(ID *id, bool do_id_user);
86
92bool BKE_animdata_id_is_animated(const ID *id);
93
99
111AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, int flag);
112
121 std::optional<Library *> owner_library,
122 AnimData *adt,
123 int flag);
124
130bool BKE_animdata_copy_id(Main *bmain, ID *id_to, ID *id_from, int flag);
131
135void BKE_animdata_copy_id_action(Main *bmain, ID *id);
136
137void BKE_animdata_duplicate_id_action(Main *bmain, ID *id, uint duplicate_flags);
138
139/* Merge copies of data from source AnimData block */
141 /* Keep destination action */
143
144 /* Use src action (make a new copy) */
146
147 /* Use src action (but just reference the existing version) */
149};
150
155 Main *bmain, ID *dst_id, ID *src_id, eAnimData_MergeCopy_Modes action_mode, bool fix_drivers);
156
157void BKE_animdata_blend_write(BlendWriter *writer, ID *id);
158void BKE_animdata_blend_read_data(BlendDataReader *reader, ID *id);
159
168
169/* ************************************* */
170/* Batch AnimData API */
171/* Loop over all datablocks applying callback */
172void BKE_animdata_main_cb(struct Main *bmain, FunctionRef<void(ID *, AnimData *)> func);
173
175void BKE_fcurves_main_cb(struct Main *bmain, FunctionRef<void(ID *, FCurve *)> func);
176
183void BKE_fcurves_id_cb(struct ID *id, FunctionRef<void(ID *, FCurve *)> func);
184
185/* ************************************* */
186/* TODO: overrides, remapping, and path-finding API's. */
187
188namespace bke::animdata {
189
206
217bool prop_is_animated(const AnimData *adt, StringRefNull rna_path, int array_index);
218
219} // namespace bke::animdata
220} // namespace blender
void action_slots_user_cache_invalidate(Main &bmain)
bool prop_is_animated(const AnimData *adt, StringRefNull rna_path, int array_index)
BMesh Iterators.
bool BKE_animdata_action_editable(const AnimData *adt)
Definition anim_data.cc:164
unsigned int uint
Definition BKE_text.h:55
void BKE_fcurves_id_cb(struct ID *id, FunctionRef< void(ID *, FCurve *)> func)
void BKE_animdata_main_cb(struct Main *bmain, FunctionRef< void(ID *, AnimData *)> func)
AnimData * BKE_animdata_copy_in_lib(Main *bmain, std::optional< Library * > owner_library, AnimData *adt, int flag)
Definition anim_data.cc:263
bool id_type_can_have_animdata(short id_type)
Definition anim_data.cc:69
bool BKE_animdata_id_is_animated(const ID *id)
Definition anim_data.cc:224
bool id_can_have_animdata(const ID *id)
Definition anim_data.cc:78
void BKE_animdata_duplicate_id_action(Main *bmain, ID *id, uint duplicate_flags)
Definition anim_data.cc:434
void BKE_animdata_blend_write(BlendWriter *writer, ID *id)
AnimData * BKE_animdata_ensure_id(ID *id)
Definition anim_data.cc:107
void BKE_animdata_blend_read_data(BlendDataReader *reader, ID *id)
bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act)
Definition anim_data.cc:135
AnimData * BKE_animdata_from_id(const ID *id)
Definition anim_data.cc:93
BMesh const char void * data
void BKE_animdata_free(ID *id, bool do_id_user)
Definition anim_data.cc:174
void BKE_animdata_foreach_id(AnimData *adt, LibraryForeachIDData *data)
Definition anim_data.cc:245
bool BKE_animdata_copy_id(Main *bmain, ID *id_to, ID *id_from, int flag)
Definition anim_data.cc:351
void BKE_fcurves_main_cb(struct Main *bmain, FunctionRef< void(ID *, FCurve *)> func)
AnimData * BKE_animdata_copy(Main *bmain, AnimData *adt, int flag)
Definition anim_data.cc:346
eAnimData_MergeCopy_Modes
@ ADT_MERGECOPY_SRC_REF
@ ADT_MERGECOPY_SRC_COPY
@ ADT_MERGECOPY_KEEP_DST
void BKE_animdata_copy_id_action(Main *bmain, ID *id)
Definition anim_data.cc:428
void BKE_animdata_merge_copy(Main *bmain, ID *dst_id, ID *src_id, eAnimData_MergeCopy_Modes action_mode, bool fix_drivers)
Definition anim_data.cc:443
void BKE_animdata_liboverride_post_process(ID *id)