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