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