Blender V5.3
BKE_animsys.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 "DNA_listBase.h"
12
13#include "BLI_bit_vector.hh"
14#include "BLI_map.hh"
15#include "BLI_span.hh"
16#include "BLI_string.hh"
17#include "BLI_sys_types.hh" /* for bool */
18
19#include "RNA_path_fwd.hh"
20
21#include <string>
22
23namespace blender {
24
25struct AnimData;
26struct BlendDataReader;
27struct BlendWriter;
28struct Depsgraph;
29struct DriverTarget;
30struct FCurve;
31struct ID;
32struct KS_Path;
33struct KeyingSet;
35struct Main;
37struct PathResolvedRNA;
38struct PointerRNA;
39struct PropertyRNA;
40struct TimeMarker;
41struct bAction;
42struct bActionGroup;
43
44enum eInsertKeyFlags : short;
45enum eKSP_Grouping : short;
46enum eKSP_Settings : short;
47enum eKS_Settings : short;
48
51 /* For drivers, so that they have access to the dependency graph and the current view layer. See
52 * #77086. */
53 Depsgraph *depsgraph;
54
55 /* FCurves and Drivers can be evaluated at a different time than the current scene time, for
56 * example when evaluating NLA strips. This means that, even though the current time is stored in
57 * the dependency graph, we need an explicit evaluation time. */
58 float eval_time;
59};
60
62 float eval_time) ATTR_WARN_UNUSED_RESULT;
64 const AnimationEvalContext *anim_eval_context, float eval_time) ATTR_WARN_UNUSED_RESULT;
65
66/* ************************************* */
67/* KeyingSets API */
68
73KeyingSet *BKE_keyingset_add(ListBaseT<KeyingSet> *list,
74 const char idname[],
75 const char name[],
76 eKS_Settings flag,
77 eInsertKeyFlags keyingflag);
78
84 ID *id,
85 const char group_name[],
86 const char rna_path[],
87 int array_index,
88 eKSP_Settings flag,
89 eKSP_Grouping groupmode);
90
96 ID *id,
97 const char group_name[],
98 const char rna_path[],
99 int array_index,
100 int group_mode);
101
103void BKE_keyingsets_copy(ListBaseT<KeyingSet> *newlist, const ListBaseT<KeyingSet> *list);
104
109void BKE_keyingsets_foreach_id(LibraryForeachIDData *data, const ListBaseT<KeyingSet> *keyingsets);
110
113
116
118void BKE_keyingsets_free(ListBaseT<KeyingSet> *list);
119
120void BKE_keyingsets_blend_write(BlendWriter *writer, ListBaseT<KeyingSet> *list);
121void BKE_keyingsets_blend_read_data(BlendDataReader *reader, ListBaseT<KeyingSet> *list);
122
123/* ************************************* */
124/* Path Fixing API */
125
137char *BKE_animsys_fix_rna_path_rename(ID *owner_id,
138 const char *old_path,
139 StringRef prefix,
140 StringRefNull old_name,
141 StringRefNull newName);
142
153 bAction *act,
154 int32_t /*slot_handle_t*/ slot_handle,
155 StringRef prefix,
156 StringRefNull oldName,
157 StringRefNull newName,
158 bool verify_paths);
159
165
186 StringRef prefix,
187 StringRef old_infix,
188 StringRef new_infix,
189 bool verify_paths,
190 const DriverMap &driver_map);
191
198 StringRef prefix,
199 StringRef old_infix,
200 StringRef new_infix,
201 bool verify_paths,
202 Main &bmain);
203
210bool BKE_animdata_fix_paths_remove(ID *id, const char *prefix);
211
218
227bool BKE_animdata_drivers_remove_for_rna_struct(ID &owner_id, struct StructRNA &type, void *data);
228
229/* -------------------------------------- */
230
232 std::string src_basepath;
233 std::string dst_basepath;
234};
235
245 const ID &src_id,
246 ID &dst_id,
248
249/* ------------ NLA Keyframing --------------- */
250
252
263 ListBaseT<NlaKeyframingContext> *cache,
264 PointerRNA *ptr,
265 AnimData *adt,
266 const AnimationEvalContext *anim_eval_context);
283 PointerRNA *prop_ptr,
284 PropertyRNA *prop,
285 const MutableSpan<float> values,
286 int index,
287 const AnimationEvalContext *anim_eval_context,
288 bool *r_force_all,
289 BitVector<> &r_values_mask);
290
294void BKE_animsys_free_nla_keyframing_context_cache(ListBaseT<NlaKeyframingContext> *cache);
295
296/* ************************************* */
297/* Evaluation API */
298
299/* ------------- Main API -------------------- */
300/* In general, these ones should be called to do all animation evaluation */
301
302/* Flags for recalc parameter, indicating which part to recalculate. */
308
309bool BKE_animsys_rna_path_resolve(PointerRNA *ptr,
310 ParsedRNAPathRef rna_path,
311 int array_index,
312 PathResolvedRNA *r_result);
313bool BKE_animsys_read_from_rna_path(PathResolvedRNA *anim_rna, float *r_value);
321bool BKE_animsys_write_to_rna_path(PathResolvedRNA *anim_rna,
322 float value,
323 bool force_write = false);
324
333 AnimData *adt,
334 const AnimationEvalContext *anim_eval_context,
335 eAnimData_Recalc recalc,
336 bool flush_to_original);
337
338/* ------------ Specialized API --------------- */
339/* There are a few special tools which require these following functions. They are NOT to be used
340 * for standard animation evaluation UNDER ANY CIRCUMSTANCES!
341 *
342 * i.e. Pose Library (PoseLib) uses some of these for selectively applying poses, but
343 * Particles/Sequencer performing funky time manipulation is not ok.
344 */
345
349void animsys_evaluate_action(PointerRNA *ptr,
350 bAction *act,
351 int32_t action_slot_handle,
352 const AnimationEvalContext *anim_eval_context,
353 bool flush_to_original);
354
356void animsys_evaluate_action_group(PointerRNA *ptr,
357 bAction *act,
358 bActionGroup *agrp,
359 const AnimationEvalContext *anim_eval_context);
360
361/* ************************************* */
362
363/* ------------ Evaluation API --------------- */
364
365void BKE_animsys_eval_animdata(Depsgraph *depsgraph, ID *id);
366void BKE_animsys_eval_driver_unshare(Depsgraph *depsgraph, ID *id);
367void BKE_animsys_eval_driver(Depsgraph *depsgraph, ID *id, int driver_index, FCurve *fcu_orig);
368
370
371/* ************************************* */
372
373void BKE_time_markers_blend_write(BlendWriter *writer, ListBaseT<TimeMarker> &markers);
374void BKE_time_markers_blend_read(BlendDataReader *reader, ListBaseT<TimeMarker> &markers);
375
383TimeMarker *BKE_copy_time_marker(const TimeMarker &marker_src, int flag);
384
392void BKE_copy_time_markers(ListBaseT<TimeMarker> &markers_dst,
393 const ListBaseT<TimeMarker> &markers_src,
394 int flag);
395
396void BKE_free_time_marker(TimeMarker &marker, bool do_id_user);
397void BKE_free_time_markers(ListBaseT<TimeMarker> &markers, bool do_id_user);
398
399} // namespace blender
These structs are the foundation for all linked lists in the library system.
BMesh Iterators.
void BKE_keyingsets_blend_read_data(BlendDataReader *reader, ListBaseT< KeyingSet > *list)
Definition anim_sys.cc:326
void BKE_copy_time_markers(ListBaseT< TimeMarker > &markers_dst, const ListBaseT< TimeMarker > &markers_src, int flag)
Definition anim_sys.cc:3962
void BKE_animsys_eval_driver_unshare(Depsgraph *depsgraph, ID *id)
Definition anim_sys.cc:3812
@ ADT_RECALC_DRIVERS
@ ADT_RECALC_ANIM
void BKE_time_markers_blend_read(BlendDataReader *reader, ListBaseT< TimeMarker > &markers)
Definition anim_sys.cc:3944
void BKE_action_fix_paths_rename(ID *owner_id, bAction *act, int32_t slot_handle, StringRef prefix, StringRefNull oldName, StringRefNull newName, bool verify_paths)
TimeMarker * BKE_copy_time_marker(const TimeMarker &marker_src, int flag)
Definition anim_sys.cc:3953
void BKE_animsys_nla_remap_keyframe_values(NlaKeyframingContext *context, PointerRNA *prop_ptr, PropertyRNA *prop, const MutableSpan< float > values, int index, const AnimationEvalContext *anim_eval_context, bool *r_force_all, BitVector<> &r_values_mask)
Definition anim_sys.cc:3524
AnimationEvalContext BKE_animsys_eval_context_construct_at(const AnimationEvalContext *anim_eval_context, float eval_time) ATTR_WARN_UNUSED_RESULT
Definition anim_sys.cc:610
void BKE_animsys_free_nla_keyframing_context_cache(ListBaseT< NlaKeyframingContext > *cache)
Definition anim_sys.cc:3648
void BKE_keyingsets_copy(ListBaseT< KeyingSet > *newlist, const ListBaseT< KeyingSet > *list)
Definition anim_sys.cc:249
void animsys_evaluate_action(PointerRNA *ptr, bAction *act, int32_t action_slot_handle, const AnimationEvalContext *anim_eval_context, bool flush_to_original)
Definition anim_sys.cc:686
KeyingSet * BKE_keyingset_add(ListBaseT< KeyingSet > *list, const char idname[], const char name[], eKS_Settings flag, eInsertKeyFlags keyingflag)
Definition anim_sys.cc:137
void BKE_keyingset_free_path(KeyingSet *ks, KS_Path *ksp)
Definition anim_sys.cc:233
void BKE_keyingset_free_paths(KeyingSet *ks)
Definition anim_sys.cc:273
Span< rna_path::Item > ParsedRNAPathRef
Definition RNA_path.hh:113
bool BKE_animdata_fix_paths_remove(ID *id, const char *prefix)
AnimationEvalContext BKE_animsys_eval_context_construct(Depsgraph *depsgraph, float eval_time) ATTR_WARN_UNUSED_RESULT
Definition anim_sys.cc:602
void BKE_animdata_fix_paths(ID &id, StringRef prefix, StringRef old_infix, StringRef new_infix, bool verify_paths, const DriverMap &driver_map)
void animsys_evaluate_action_group(PointerRNA *ptr, bAction *act, bActionGroup *agrp, const AnimationEvalContext *anim_eval_context)
Definition anim_sys.cc:654
void BKE_keyingsets_foreach_id(LibraryForeachIDData *data, const ListBaseT< KeyingSet > *keyingsets)
Definition anim_sys.cc:262
void BKE_keyingsets_blend_write(BlendWriter *writer, ListBaseT< KeyingSet > *list)
Definition anim_sys.cc:308
BMesh const char void * data
void BKE_time_markers_blend_write(BlendWriter *writer, ListBaseT< TimeMarker > &markers)
Definition anim_sys.cc:3933
DriverMap BKE_animdata_build_driver_target_map(Main &bmain)
Definition anim_data.cc:980
void BKE_free_time_marker(TimeMarker &marker, bool do_id_user)
Definition anim_sys.cc:3974
bool BKE_animsys_read_from_rna_path(PathResolvedRNA *anim_rna, float *r_value)
Definition anim_sys.cc:400
void BKE_animsys_update_driver_array(ID *id)
Definition anim_sys.cc:3791
bool BKE_animdata_driver_path_remove(ID *id, StringRefNull prefix)
void BKE_animdata_copy_by_basepath(Main &bmain, const ID &src_id, ID &dst_id, Span< AnimationBasePathChange > basepaths)
Definition anim_data.cc:640
void BKE_animsys_evaluate_animdata(ID *id, AnimData *adt, const AnimationEvalContext *anim_eval_context, eAnimData_Recalc recalc, bool flush_to_original)
Definition anim_sys.cc:3716
bool BKE_animsys_write_to_rna_path(PathResolvedRNA *anim_rna, float value, bool force_write=false)
Definition anim_sys.cc:461
void BKE_free_time_markers(ListBaseT< TimeMarker > &markers, bool do_id_user)
Definition anim_sys.cc:3982
NlaKeyframingContext * BKE_animsys_get_nla_keyframing_context(ListBaseT< NlaKeyframingContext > *cache, PointerRNA *ptr, AnimData *adt, const AnimationEvalContext *anim_eval_context)
Definition anim_sys.cc:3478
signed int int32_t
Definition BKE_text.h:78
bool BKE_animsys_rna_path_resolve(PointerRNA *ptr, ParsedRNAPathRef rna_path, int array_index, PathResolvedRNA *r_result)
Definition anim_sys.cc:356
Map< ID *, Vector< DriverTarget * > > DriverMap
KS_Path * BKE_keyingset_find_path(KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, int group_mode)
Definition anim_sys.cc:87
void BKE_keyingsets_free(ListBaseT< KeyingSet > *list)
Definition anim_sys.cc:289
bool ATTR_WARN_UNUSED_RESULT
bool BKE_animdata_drivers_remove_for_rna_struct(ID &owner_id, struct StructRNA &type, void *data)
KS_Path * BKE_keyingset_add_path(KeyingSet *ks, ID *id, const char group_name[], const char rna_path[], int array_index, eKSP_Settings flag, eKSP_Grouping groupmode)
Definition anim_sys.cc:170
char * BKE_animsys_fix_rna_path_rename(ID *owner_id, const char *old_path, StringRef prefix, StringRefNull old_name, StringRefNull newName)
Definition anim_data.cc:882
void BKE_animsys_eval_driver(Depsgraph *depsgraph, ID *id, int driver_index, FCurve *fcu_orig)
Definition anim_sys.cc:3844
void BKE_animsys_eval_animdata(Depsgraph *depsgraph, ID *id)
Definition anim_sys.cc:3777