* merge r22734 from trunk
[blender.git] / source / blender / blenkernel / BKE_nla.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2009 Blender Foundation, Joshua Leung
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): Joshua Leung (full recode)
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BKE_NLA_H
31 #define BKE_NLA_H
32
33 struct AnimData;
34 struct NlaStrip;
35 struct NlaTrack;
36 struct bAction;
37
38 /* ----------------------------- */
39 /* Data Management */
40
41 void free_nlastrip(ListBase *strips, struct NlaStrip *strip);
42 void free_nlatrack(ListBase *tracks, struct NlaTrack *nlt);
43 void free_nladata(ListBase *tracks);
44
45 struct NlaStrip *copy_nlastrip(struct NlaStrip *strip);
46 struct NlaTrack *copy_nlatrack(struct NlaTrack *nlt);
47 void copy_nladata(ListBase *dst, ListBase *src);
48
49 struct NlaTrack *add_nlatrack(struct AnimData *adt, struct NlaTrack *prev);
50 struct NlaStrip *add_nlastrip(struct bAction *act);
51 struct NlaStrip *add_nlastrip_to_stack(struct AnimData *adt, struct bAction *act);
52
53 /* ----------------------------- */
54 /* API */
55
56 short BKE_nlastrips_has_space(ListBase *strips, float start, float end);
57 void BKE_nlastrips_sort_strips(ListBase *strips);
58
59 short BKE_nlastrips_add_strip(ListBase *strips, struct NlaStrip *strip);
60
61
62 void BKE_nlastrips_make_metas(ListBase *strips, short temp);
63 void BKE_nlastrips_clear_metas(ListBase *strips, short onlySel, short onlyTemp);
64 void BKE_nlastrips_clear_metastrip(ListBase *strips, struct NlaStrip *strip);
65 short 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 void BKE_nlatrack_solo_toggle(struct AnimData *adt, struct NlaTrack *nlt);
74
75 short BKE_nlatrack_has_space(struct NlaTrack *nlt, float start, float end);
76 void BKE_nlatrack_sort_strips(struct NlaTrack *nlt);
77
78 short BKE_nlatrack_add_strip(struct NlaTrack *nlt, struct NlaStrip *strip);
79
80 /* ............ */
81
82 struct NlaStrip *BKE_nlastrip_find_active(struct NlaTrack *nlt);
83 void BKE_nlastrip_set_active(struct AnimData *adt, struct NlaStrip *strip);
84
85 short BKE_nlastrip_within_bounds(struct NlaStrip *strip, float min, float max);
86
87 void BKE_nlastrip_validate_name(struct AnimData *adt, struct NlaStrip *strip);
88
89 /* ............ */
90
91 short BKE_nlatrack_has_animated_strips(struct NlaTrack *nlt);
92 short BKE_nlatracks_have_animated_strips(ListBase *tracks);
93 void BKE_nlastrip_validate_fcurves(struct NlaStrip *strip);
94
95 void BKE_nla_validate_state(struct AnimData *adt);
96
97 /* ............ */
98
99 void BKE_nla_action_pushdown(struct AnimData *adt);
100
101 short BKE_nla_tweakmode_enter(struct AnimData *adt);
102 void BKE_nla_tweakmode_exit(struct AnimData *adt);
103
104 /* ----------------------------- */
105 /* Time Mapping */
106
107 /* time mapping conversion modes */
108 enum {
109                 /* convert from global time to strip time - for evaluation */
110         NLATIME_CONVERT_EVAL = 0,
111                 /* convert from global time to strip time - for editing corrections */
112                 // XXX old 0 invert
113         NLATIME_CONVERT_UNMAP,
114                 /* convert from strip time to global time */
115                 // xxx old 1 invert
116         NLATIME_CONVERT_MAP,
117 } eNlaTime_ConvertModes;
118
119 float BKE_nla_tweakedit_remap(struct AnimData *adt, float cframe, short mode);
120
121 #endif
122