Blender V5.3
BKE_nla.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
12#define NLASTRIP_MIN_LEN_THRESH 0.1f
13
14#include "DNA_listBase.h"
15
16#include "BKE_action.hh"
17#include "BKE_anim_data.hh"
18
19#include "BLI_function_ref.hh"
20
21namespace blender {
22
23struct AnimData;
24struct ID;
25struct LibraryForeachIDData;
26struct Main;
27struct NlaStrip;
28struct NlaTrack;
29struct Scene;
30struct Speaker;
31struct bAction;
32
33struct BlendDataReader;
34struct BlendWriter;
35struct PointerRNA;
36struct PropertyRNA;
37
38/* ----------------------------- */
39/* Data Management */
40
45struct NlaTrack *BKE_nlatrack_new();
46
51void BKE_nlastrip_free(NlaStrip *strip, bool do_id_user);
56void BKE_nlatrack_free(NlaTrack *nlt, bool do_id_user);
61void BKE_nla_tracks_free(ListBaseT<NlaTrack> *tracks, bool do_id_user);
62
70NlaStrip *BKE_nlastrip_copy(Main *bmain, NlaStrip *strip, bool use_same_action, int flag);
76NlaTrack *BKE_nlatrack_copy(Main *bmain, NlaTrack *nlt, bool use_same_actions, int flag);
82void BKE_nla_tracks_copy(Main *bmain,
83 ListBaseT<NlaTrack> *dst,
84 const ListBaseT<NlaTrack> *src,
85 int flag);
86
91void BKE_nla_tracks_copy_from_adt(Main *bmain,
92 AnimData *adt_dest,
93 const AnimData *adt_source,
94 int flag);
95
100void BKE_nlatrack_insert_before(ListBaseT<NlaTrack> *nla_tracks,
101 NlaTrack *next,
102 NlaTrack *new_track,
103 bool is_liboverride);
104
109void BKE_nlatrack_insert_after(ListBaseT<NlaTrack> *nla_tracks,
110 NlaTrack *prev,
111 NlaTrack *new_track,
112 bool is_liboverride);
113
118NlaTrack *BKE_nlatrack_new_before(ListBaseT<NlaTrack> *nla_tracks,
119 NlaTrack *next,
120 bool is_liboverride);
121
126NlaTrack *BKE_nlatrack_new_after(ListBaseT<NlaTrack> *nla_tracks,
127 NlaTrack *prev,
128 bool is_liboverride);
129
134NlaTrack *BKE_nlatrack_new_head(ListBaseT<NlaTrack> *nla_tracks, bool is_liboverride);
135
140NlaTrack *BKE_nlatrack_new_tail(ListBaseT<NlaTrack> *nla_tracks, const bool is_liboverride);
141
145void BKE_nlatrack_remove(ListBaseT<NlaTrack> *tracks, NlaTrack *nlt);
146
151void BKE_nlatrack_remove_and_free(ListBaseT<NlaTrack> *tracks, NlaTrack *nlt, bool do_id_user);
152
159bool BKE_nlatrack_is_enabled(const AnimData &adt, const NlaTrack &nlt);
160
178float BKE_nla_clip_length_get_nonzero(const NlaStrip *strip);
179
191void BKE_nla_clip_length_ensure_nonzero(const float *actstart, float *r_actend);
192
199NlaStrip *BKE_nlastrip_new(bAction *act, ID &animated_id);
200
209NlaStrip *BKE_nlastrip_new_for_slot(bAction *act,
210 animrig::slot_handle_t slot_handle,
211 ID &animated_id);
212
213/*
214 * Removes the given NLA strip from the list of strips provided.
215 */
216void BKE_nlastrip_remove(ListBaseT<NlaStrip> *strips, NlaStrip *strip);
217
218/*
219 * Removes the given NLA strip from the list of strips provided, and frees it's memory.
220 */
221void BKE_nlastrip_remove_and_free(ListBaseT<NlaStrip> *strips,
222 NlaStrip *strip,
223 const bool do_id_user);
224
229NlaStrip *BKE_nlastack_add_strip(OwnedAnimData owned_adt, const bool is_liboverride);
230
234NlaStrip *BKE_nla_add_soundstrip(Main *bmain, Scene *scene, Speaker *speaker);
235
240void BKE_nla_strip_foreach_id(NlaStrip *strip, LibraryForeachIDData *data);
241
242/* ----------------------------- */
243/* API */
244
248bool BKE_nlastrips_has_space(ListBaseT<NlaStrip> *strips, float start, float end);
253void BKE_nlastrips_sort_strips(ListBaseT<NlaStrip> *strips);
254
260void BKE_nlastrips_add_strip_unsafe(ListBaseT<NlaStrip> *strips, NlaStrip *strip);
261
267bool BKE_nlastrips_add_strip(ListBaseT<NlaStrip> *strips, NlaStrip *strip);
268
275void BKE_nlastrips_make_metas(ListBaseT<NlaStrip> *strips, bool is_temp);
282void BKE_nlastrips_clear_metas(ListBaseT<NlaStrip> *strips, bool only_sel, bool only_temp);
286void BKE_nlastrips_clear_metastrip(ListBaseT<NlaStrip> *strips, NlaStrip *strip);
291bool BKE_nlameta_add_strip(NlaStrip *mstrip, NlaStrip *strip);
296void BKE_nlameta_flush_transforms(NlaStrip *mstrip);
297
298/* ............ */
299
303NlaTrack *BKE_nlatrack_find_active(ListBaseT<NlaTrack> *tracks);
308void BKE_nlatrack_set_active(ListBaseT<NlaTrack> *tracks, NlaTrack *nlt);
309
316NlaTrack *BKE_nlatrack_find_tweaked(AnimData *adt);
317
322void BKE_nlatrack_solo_toggle(AnimData *adt, NlaTrack *nlt);
323
327bool BKE_nlatrack_has_space(NlaTrack *nlt, float start, float end);
328
332bool BKE_nlatrack_has_strips(ListBaseT<NlaTrack> *tracks);
333
338void BKE_nlatrack_sort_strips(NlaTrack *nlt);
339
344bool BKE_nlatrack_add_strip(NlaTrack *nlt, NlaStrip *strip, bool is_liboverride);
345
349void BKE_nlatrack_remove_strip(NlaTrack *track, NlaStrip *strip);
350
355bool BKE_nlatrack_get_bounds(NlaTrack *nlt, float bounds[2]);
362bool BKE_nlatrack_is_nonlocal_in_liboverride(const ID *id, const NlaTrack *nlt);
363
364/* ............ */
365
389float BKE_nlastrip_compute_frame_to_next_strip(NlaStrip *strip);
390
398NlaStrip *BKE_nlastrip_next_in_track(NlaStrip *strip, bool skip_transitions);
399
407NlaStrip *BKE_nlastrip_prev_in_track(NlaStrip *strip, bool skip_transitions);
408
409/* ............ */
410
414NlaStrip *BKE_nlastrip_find_active(NlaTrack *nlt);
418void BKE_nlastrip_set_active(AnimData *adt, NlaStrip *strip);
424NlaStrip *BKE_nlastrip_find_by_name(NlaTrack *nlt, const char *name);
425
429bool BKE_nlastrip_within_bounds(NlaStrip *strip, float min, float max);
434float BKE_nlastrip_distance_to_frame(const NlaStrip *strip, float timeline_frame);
439void BKE_nlastrip_recalculate_bounds(NlaStrip *strip);
445
449void BKE_nlastrip_recalculate_blend(NlaStrip *strip);
450
457void BKE_nlastrip_validate_name(AnimData *adt, NlaStrip *strip);
458
459/* ............ */
460
464bool BKE_nlatrack_has_animated_strips(NlaTrack *nlt);
468bool BKE_nlatracks_have_animated_strips(ListBaseT<NlaTrack> *tracks);
472void BKE_nlastrip_validate_fcurves(NlaStrip *strip);
473
481bool BKE_nlastrip_controlcurve_remove(NlaStrip *strip, FCurve *fcurve);
482
487bool BKE_nlastrip_has_curves_for_property(const PointerRNA *ptr, const PropertyRNA *prop);
488
492void BKE_nla_validate_state(AnimData *adt);
493
494/* ............ */
495
503bool BKE_nla_action_slot_is_stashed(AnimData *adt,
504 bAction *act,
505 animrig::slot_handle_t slot_handle);
510bool BKE_nla_action_stash(OwnedAnimData owned_adt, bool is_liboverride);
511
512/* ............ */
513
522void BKE_nla_action_pushdown(OwnedAnimData owned_adt, bool is_liboverride);
523
528bool BKE_nla_tweakmode_enter(OwnedAnimData owned_adt);
532void BKE_nla_tweakmode_exit(OwnedAnimData owned_adt);
533
537void BKE_nla_tweakmode_clear_flags(AnimData *adt);
538
549void BKE_nla_tweakmode_exit_nofollowptr(AnimData *adt);
550
551/* ----------------------------- */
552/* Time Mapping */
553
554/* time mapping conversion modes */
556 /* convert from global time to strip time - for evaluation */
558 /* convert from global time to strip time - for editing corrections */
559 /* XXX: old 0 invert. */
561 /* convert from strip time to global time */
562 /* XXX: old 1 invert. */
564};
565
578float BKE_nla_tweakedit_remap(AnimData *adt, float cframe, eNlaTime_ConvertModes mode);
579
580/* ----------------------------- */
581/* .blend file API */
582
583void BKE_nla_blend_write(BlendWriter *writer, ListBaseT<NlaTrack> *tracks);
584void BKE_nla_blend_read_data(BlendDataReader *reader, ID *id_owner, ListBaseT<NlaTrack> *tracks);
585
592void BKE_nla_liboverride_post_process(ID *id, AnimData *adt);
593
603void BKE_nla_debug_print_flags(AnimData *adt, ID *owner_id);
604
605namespace bke::nla {
606
620bool foreach_strip(ID *id, FunctionRef<bool(NlaStrip *)> callback);
621
635bool foreach_strip_adt(const AnimData &adt, FunctionRef<bool(NlaStrip *)> callback);
636
637} // namespace bke::nla
638} // namespace blender
Blender kernel action and pose functionality.
These structs are the foundation for all linked lists in the library system.
static btDbvtVolume bounds(btDbvtNode **leaves, int count)
Definition btDbvt.cpp:299
btScalar max
Definition scene.h:133
decltype(blender::ActionSlot::handle) slot_handle_t
bool foreach_strip(ID *id, FunctionRef< bool(NlaStrip *)> callback)
bool foreach_strip_adt(const AnimData &adt, FunctionRef< bool(NlaStrip *)> callback)
BMesh Iterators.
void BKE_nlastrips_add_strip_unsafe(ListBaseT< NlaStrip > *strips, NlaStrip *strip)
NlaTrack * BKE_nlatrack_new_head(ListBaseT< NlaTrack > *nla_tracks, bool is_liboverride)
bool BKE_nlatrack_has_animated_strips(NlaTrack *nlt)
float BKE_nla_tweakedit_remap(AnimData *adt, float cframe, eNlaTime_ConvertModes mode)
NlaStrip * BKE_nlastrip_find_by_name(NlaTrack *nlt, const char *name)
void BKE_nlastrip_recalculate_blend(NlaStrip *strip)
void BKE_nlameta_flush_transforms(NlaStrip *mstrip)
void BKE_nlatrack_free(NlaTrack *nlt, bool do_id_user)
NlaStrip * BKE_nla_add_soundstrip(Main *bmain, Scene *scene, Speaker *speaker)
struct NlaTrack * BKE_nlatrack_new()
void BKE_nlatrack_set_active(ListBaseT< NlaTrack > *tracks, NlaTrack *nlt)
void BKE_nla_blend_read_data(BlendDataReader *reader, ID *id_owner, ListBaseT< NlaTrack > *tracks)
bool BKE_nlatrack_add_strip(NlaTrack *nlt, NlaStrip *strip, bool is_liboverride)
eNlaTime_ConvertModes
Definition BKE_nla.hh:555
@ NLATIME_CONVERT_EVAL
Definition BKE_nla.hh:557
@ NLATIME_CONVERT_UNMAP
Definition BKE_nla.hh:560
@ NLATIME_CONVERT_MAP
Definition BKE_nla.hh:563
float BKE_nla_clip_length_get_nonzero(const NlaStrip *strip)
NlaTrack * BKE_nlatrack_find_active(ListBaseT< NlaTrack > *tracks)
NlaTrack * BKE_nlatrack_find_tweaked(AnimData *adt)
void BKE_nlastrip_validate_name(AnimData *adt, NlaStrip *strip)
void BKE_nla_liboverride_post_process(ID *id, AnimData *adt)
void BKE_nlastrip_validate_fcurves(NlaStrip *strip)
NlaTrack * BKE_nlatrack_new_before(ListBaseT< NlaTrack > *nla_tracks, NlaTrack *next, bool is_liboverride)
void BKE_nla_tweakmode_exit(OwnedAnimData owned_adt)
bool BKE_nlatrack_get_bounds(NlaTrack *nlt, float bounds[2])
NlaStrip * BKE_nlastrip_new(bAction *act, ID &animated_id)
bool BKE_nlatrack_is_nonlocal_in_liboverride(const ID *id, const NlaTrack *nlt)
void BKE_nla_strip_foreach_id(NlaStrip *strip, LibraryForeachIDData *data)
bool BKE_nlastrip_has_curves_for_property(const PointerRNA *ptr, const PropertyRNA *prop)
bool BKE_nlastrip_controlcurve_remove(NlaStrip *strip, FCurve *fcurve)
void BKE_nla_clip_length_ensure_nonzero(const float *actstart, float *r_actend)
void BKE_nla_validate_state(AnimData *adt)
bool BKE_nlatrack_has_strips(ListBaseT< NlaTrack > *tracks)
bool BKE_nlatrack_is_enabled(const AnimData &adt, const NlaTrack &nlt)
void BKE_nla_tracks_free(ListBaseT< NlaTrack > *tracks, bool do_id_user)
NlaStrip * BKE_nlastrip_find_active(NlaTrack *nlt)
BMesh const char void * data
NlaStrip * BKE_nlastrip_copy(Main *bmain, NlaStrip *strip, bool use_same_action, int flag)
bool BKE_nlastrips_has_space(ListBaseT< NlaStrip > *strips, float start, float end)
void BKE_nla_action_pushdown(OwnedAnimData owned_adt, bool is_liboverride)
float BKE_nlastrip_compute_frame_to_next_strip(NlaStrip *strip)
NlaTrack * BKE_nlatrack_new_tail(ListBaseT< NlaTrack > *nla_tracks, const bool is_liboverride)
NlaTrack * BKE_nlatrack_copy(Main *bmain, NlaTrack *nlt, bool use_same_actions, int flag)
void BKE_nla_tracks_copy(Main *bmain, ListBaseT< NlaTrack > *dst, const ListBaseT< NlaTrack > *src, int flag)
void BKE_nla_tweakmode_clear_flags(AnimData *adt)
bool BKE_nla_action_slot_is_stashed(AnimData *adt, bAction *act, animrig::slot_handle_t slot_handle)
NlaStrip * BKE_nlastrip_next_in_track(NlaStrip *strip, bool skip_transitions)
void BKE_nlatrack_solo_toggle(AnimData *adt, NlaTrack *nlt)
void BKE_nlatrack_insert_before(ListBaseT< NlaTrack > *nla_tracks, NlaTrack *next, NlaTrack *new_track, bool is_liboverride)
void BKE_nlastrips_sort_strips(ListBaseT< NlaStrip > *strips)
bool BKE_nlastrip_within_bounds(NlaStrip *strip, float min, float max)
void BKE_nla_blend_write(BlendWriter *writer, ListBaseT< NlaTrack > *tracks)
void BKE_nlastrip_set_active(AnimData *adt, NlaStrip *strip)
float BKE_nlastrip_compute_frame_from_previous_strip(NlaStrip *strip)
void BKE_nlastrip_recalculate_bounds_sync_action(NlaStrip *strip)
void BKE_nlastrips_clear_metas(ListBaseT< NlaStrip > *strips, bool only_sel, bool only_temp)
NlaStrip * BKE_nlastrip_prev_in_track(NlaStrip *strip, bool skip_transitions)
void BKE_nla_tweakmode_exit_nofollowptr(AnimData *adt)
NlaTrack * BKE_nlatrack_new_after(ListBaseT< NlaTrack > *nla_tracks, NlaTrack *prev, bool is_liboverride)
void BKE_nlastrip_recalculate_bounds(NlaStrip *strip)
void BKE_nlatrack_remove_strip(NlaTrack *track, NlaStrip *strip)
NlaStrip * BKE_nlastrip_new_for_slot(bAction *act, animrig::slot_handle_t slot_handle, ID &animated_id)
bool BKE_nlastrips_add_strip(ListBaseT< NlaStrip > *strips, NlaStrip *strip)
void BKE_nlastrip_remove(ListBaseT< NlaStrip > *strips, NlaStrip *strip)
void BKE_nlatrack_remove_and_free(ListBaseT< NlaTrack > *tracks, NlaTrack *nlt, bool do_id_user)
NlaStrip * BKE_nlastack_add_strip(OwnedAnimData owned_adt, const bool is_liboverride)
void BKE_nla_debug_print_flags(AnimData *adt, ID *owner_id)
void BKE_nlatrack_sort_strips(NlaTrack *nlt)
void BKE_nlastrips_make_metas(ListBaseT< NlaStrip > *strips, bool is_temp)
bool BKE_nlatrack_has_space(NlaTrack *nlt, float start, float end)
bool BKE_nlameta_add_strip(NlaStrip *mstrip, NlaStrip *strip)
bool BKE_nla_action_stash(OwnedAnimData owned_adt, bool is_liboverride)
void BKE_nlastrips_clear_metastrip(ListBaseT< NlaStrip > *strips, NlaStrip *strip)
void BKE_nlastrip_remove_and_free(ListBaseT< NlaStrip > *strips, NlaStrip *strip, const bool do_id_user)
bool BKE_nla_tweakmode_enter(OwnedAnimData owned_adt)
void BKE_nlatrack_remove(ListBaseT< NlaTrack > *tracks, NlaTrack *nlt)
float BKE_nlastrip_distance_to_frame(const NlaStrip *strip, float timeline_frame)
bool BKE_nlatracks_have_animated_strips(ListBaseT< NlaTrack > *tracks)
void BKE_nlastrip_free(NlaStrip *strip, bool do_id_user)
void BKE_nlatrack_insert_after(ListBaseT< NlaTrack > *nla_tracks, NlaTrack *prev, NlaTrack *new_track, bool is_liboverride)
void BKE_nla_tracks_copy_from_adt(Main *bmain, AnimData *adt_dest, const AnimData *adt_source, int flag)
#define min(a, b)
Definition sort.cc:38