Fix T66948: Outliner - collections/objects with wrong active state
[blender.git] / source / blender / blenkernel / BKE_nla.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_NLA_H__
21 #define __BKE_NLA_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 struct AnimData;
28 struct Main;
29 struct NlaStrip;
30 struct NlaTrack;
31 struct Scene;
32 struct Speaker;
33 struct bAction;
34
35 struct PointerRNA;
36 struct PropertyRNA;
37
38 /* ----------------------------- */
39 /* Data Management */
40
41 void BKE_nlastrip_free(ListBase *strips, struct NlaStrip *strip, bool do_id_user);
42 void BKE_nlatrack_free(ListBase *tracks, struct NlaTrack *nlt, bool do_id_user);
43 void BKE_nla_tracks_free(ListBase *tracks, bool do_id_user);
44
45 struct NlaStrip *BKE_nlastrip_copy(struct Main *bmain,
46                                    struct NlaStrip *strip,
47                                    const bool use_same_action,
48                                    const int flag);
49 struct NlaTrack *BKE_nlatrack_copy(struct Main *bmain,
50                                    struct NlaTrack *nlt,
51                                    const bool use_same_actions,
52                                    const int flag);
53 void BKE_nla_tracks_copy(struct Main *bmain, ListBase *dst, ListBase *src, const int flag);
54
55 struct NlaTrack *BKE_nlatrack_add(struct AnimData *adt, struct NlaTrack *prev);
56 struct NlaStrip *BKE_nlastrip_new(struct bAction *act);
57 struct NlaStrip *BKE_nlastack_add_strip(struct AnimData *adt, struct bAction *act);
58 struct NlaStrip *BKE_nla_add_soundstrip(struct Main *bmain,
59                                         struct Scene *scene,
60                                         struct Speaker *spk);
61
62 /* ----------------------------- */
63 /* API */
64
65 bool BKE_nlastrips_has_space(ListBase *strips, float start, float end);
66 void BKE_nlastrips_sort_strips(ListBase *strips);
67
68 bool BKE_nlastrips_add_strip(ListBase *strips, struct NlaStrip *strip);
69
70 void BKE_nlastrips_make_metas(ListBase *strips, bool is_temp);
71 void BKE_nlastrips_clear_metas(ListBase *strips, bool only_sel, bool only_temp);
72 void BKE_nlastrips_clear_metastrip(ListBase *strips, struct NlaStrip *strip);
73 bool BKE_nlameta_add_strip(struct NlaStrip *mstrip, struct NlaStrip *strip);
74 void BKE_nlameta_flush_transforms(struct NlaStrip *mstrip);
75
76 /* ............ */
77
78 struct NlaTrack *BKE_nlatrack_find_active(ListBase *tracks);
79 void BKE_nlatrack_set_active(ListBase *tracks, struct NlaTrack *nlt);
80
81 struct NlaTrack *BKE_nlatrack_find_tweaked(struct AnimData *adt);
82
83 void BKE_nlatrack_solo_toggle(struct AnimData *adt, struct NlaTrack *nlt);
84
85 bool BKE_nlatrack_has_space(struct NlaTrack *nlt, float start, float end);
86 void BKE_nlatrack_sort_strips(struct NlaTrack *nlt);
87
88 bool BKE_nlatrack_add_strip(struct NlaTrack *nlt, struct NlaStrip *strip);
89
90 bool BKE_nlatrack_get_bounds(struct NlaTrack *nlt, float bounds[2]);
91
92 /* ............ */
93
94 struct NlaStrip *BKE_nlastrip_find_active(struct NlaTrack *nlt);
95 void BKE_nlastrip_set_active(struct AnimData *adt, struct NlaStrip *strip);
96
97 bool BKE_nlastrip_within_bounds(struct NlaStrip *strip, float min, float max);
98 void BKE_nlastrip_recalculate_bounds(struct NlaStrip *strip);
99
100 void BKE_nlastrip_validate_name(struct AnimData *adt, struct NlaStrip *strip);
101
102 /* ............ */
103
104 bool BKE_nlatrack_has_animated_strips(struct NlaTrack *nlt);
105 bool BKE_nlatracks_have_animated_strips(ListBase *tracks);
106 void BKE_nlastrip_validate_fcurves(struct NlaStrip *strip);
107
108 bool BKE_nlastrip_has_curves_for_property(const struct PointerRNA *ptr,
109                                           const struct PropertyRNA *prop);
110
111 void BKE_nla_validate_state(struct AnimData *adt);
112
113 /* ............ */
114
115 bool BKE_nla_action_is_stashed(struct AnimData *adt, struct bAction *act);
116 bool BKE_nla_action_stash(struct AnimData *adt);
117
118 /* ............ */
119
120 void BKE_nla_action_pushdown(struct AnimData *adt);
121
122 bool BKE_nla_tweakmode_enter(struct AnimData *adt);
123 void BKE_nla_tweakmode_exit(struct AnimData *adt);
124
125 /* ----------------------------- */
126 /* Time Mapping */
127
128 /* time mapping conversion modes */
129 enum eNlaTime_ConvertModes {
130   /* convert from global time to strip time - for evaluation */
131   NLATIME_CONVERT_EVAL = 0,
132   /* convert from global time to strip time - for editing corrections */
133   // XXX old 0 invert
134   NLATIME_CONVERT_UNMAP,
135   /* convert from strip time to global time */
136   // xxx old 1 invert
137   NLATIME_CONVERT_MAP,
138 };
139
140 float BKE_nla_tweakedit_remap(struct AnimData *adt, float cframe, short mode);
141
142 #endif