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