Clang-Tidy: Enable redundant static qualifier warning
[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 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 struct AnimData;
32 struct LibraryForeachIDData;
33 struct Main;
34 struct NlaStrip;
35 struct NlaTrack;
36 struct Scene;
37 struct Speaker;
38 struct bAction;
39
40 struct PointerRNA;
41 struct PropertyRNA;
42
43 /* ----------------------------- */
44 /* Data Management */
45
46 void BKE_nlastrip_free(ListBase *strips, struct NlaStrip *strip, bool do_id_user);
47 void BKE_nlatrack_free(ListBase *tracks, struct NlaTrack *nlt, bool do_id_user);
48 void BKE_nla_tracks_free(ListBase *tracks, bool do_id_user);
49
50 struct NlaStrip *BKE_nlastrip_copy(struct Main *bmain,
51                                    struct NlaStrip *strip,
52                                    const bool use_same_action,
53                                    const int flag);
54 struct NlaTrack *BKE_nlatrack_copy(struct Main *bmain,
55                                    struct NlaTrack *nlt,
56                                    const bool use_same_actions,
57                                    const int flag);
58 void BKE_nla_tracks_copy(struct Main *bmain, ListBase *dst, ListBase *src, const int flag);
59
60 struct NlaTrack *BKE_nlatrack_add(struct AnimData *adt, struct NlaTrack *prev);
61 struct NlaStrip *BKE_nlastrip_new(struct bAction *act);
62 struct NlaStrip *BKE_nlastack_add_strip(struct AnimData *adt, struct bAction *act);
63 struct NlaStrip *BKE_nla_add_soundstrip(struct Main *bmain,
64                                         struct Scene *scene,
65                                         struct Speaker *spk);
66
67 void BKE_nla_strip_foreach_id(struct NlaStrip *strip, struct LibraryForeachIDData *data);
68
69 /* ----------------------------- */
70 /* API */
71
72 bool BKE_nlastrips_has_space(ListBase *strips, float start, float end);
73 void BKE_nlastrips_sort_strips(ListBase *strips);
74
75 bool BKE_nlastrips_add_strip(ListBase *strips, struct NlaStrip *strip);
76
77 void BKE_nlastrips_make_metas(ListBase *strips, bool is_temp);
78 void BKE_nlastrips_clear_metas(ListBase *strips, bool only_sel, bool only_temp);
79 void BKE_nlastrips_clear_metastrip(ListBase *strips, struct NlaStrip *strip);
80 bool BKE_nlameta_add_strip(struct NlaStrip *mstrip, struct NlaStrip *strip);
81 void BKE_nlameta_flush_transforms(struct NlaStrip *mstrip);
82
83 /* ............ */
84
85 struct NlaTrack *BKE_nlatrack_find_active(ListBase *tracks);
86 void BKE_nlatrack_set_active(ListBase *tracks, struct NlaTrack *nlt);
87
88 struct NlaTrack *BKE_nlatrack_find_tweaked(struct AnimData *adt);
89
90 void BKE_nlatrack_solo_toggle(struct AnimData *adt, struct NlaTrack *nlt);
91
92 bool BKE_nlatrack_has_space(struct NlaTrack *nlt, float start, float end);
93 void BKE_nlatrack_sort_strips(struct NlaTrack *nlt);
94
95 bool BKE_nlatrack_add_strip(struct NlaTrack *nlt, struct NlaStrip *strip);
96
97 bool BKE_nlatrack_get_bounds(struct NlaTrack *nlt, float bounds[2]);
98
99 /* ............ */
100
101 struct NlaStrip *BKE_nlastrip_find_active(struct NlaTrack *nlt);
102 void BKE_nlastrip_set_active(struct AnimData *adt, struct NlaStrip *strip);
103
104 bool BKE_nlastrip_within_bounds(struct NlaStrip *strip, float min, float max);
105 void BKE_nlastrip_recalculate_bounds(struct NlaStrip *strip);
106
107 void BKE_nlastrip_validate_name(struct AnimData *adt, struct NlaStrip *strip);
108
109 /* ............ */
110
111 bool BKE_nlatrack_has_animated_strips(struct NlaTrack *nlt);
112 bool BKE_nlatracks_have_animated_strips(ListBase *tracks);
113 void BKE_nlastrip_validate_fcurves(struct NlaStrip *strip);
114
115 bool BKE_nlastrip_has_curves_for_property(const struct PointerRNA *ptr,
116                                           const struct PropertyRNA *prop);
117
118 void BKE_nla_validate_state(struct AnimData *adt);
119
120 /* ............ */
121
122 bool BKE_nla_action_is_stashed(struct AnimData *adt, struct bAction *act);
123 bool BKE_nla_action_stash(struct AnimData *adt);
124
125 /* ............ */
126
127 void BKE_nla_action_pushdown(struct AnimData *adt);
128
129 bool BKE_nla_tweakmode_enter(struct AnimData *adt);
130 void BKE_nla_tweakmode_exit(struct AnimData *adt);
131
132 /* ----------------------------- */
133 /* Time Mapping */
134
135 /* time mapping conversion modes */
136 enum eNlaTime_ConvertModes {
137   /* convert from global time to strip time - for evaluation */
138   NLATIME_CONVERT_EVAL = 0,
139   /* convert from global time to strip time - for editing corrections */
140   // XXX old 0 invert
141   NLATIME_CONVERT_UNMAP,
142   /* convert from strip time to global time */
143   // xxx old 1 invert
144   NLATIME_CONVERT_MAP,
145 };
146
147 float BKE_nla_tweakedit_remap(struct AnimData *adt, float cframe, short mode);
148
149 #ifdef __cplusplus
150 }
151 #endif
152
153 #endif