NLA SoC: Merge from 2.5 - 21179 to 21209
[blender-staging.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 struct NlaTrack *BKE_nlatrack_find_active(ListBase *tracks);
57 void BKE_nlatrack_set_active(ListBase *tracks, struct NlaTrack *nlt);
58
59 void BKE_nlatrack_solo_toggle(struct AnimData *adt, struct NlaTrack *nlt);
60
61 short BKE_nlatrack_has_space(struct NlaTrack *nlt, float start, float end);
62 void BKE_nlatrack_sort_strips(struct NlaTrack *nlt);
63
64 short BKE_nlatrack_add_strip(struct NlaTrack *nlt, struct NlaStrip *strip);
65
66
67 struct NlaStrip *BKE_nlastrip_find_active(struct NlaTrack *nlt);
68 short BKE_nlastrip_within_bounds(struct NlaStrip *strip, float min, float max);
69
70
71 void BKE_nla_action_pushdown(struct AnimData *adt);
72
73 short BKE_nla_tweakmode_enter(struct AnimData *adt);
74 void BKE_nla_tweakmode_exit(struct AnimData *adt);
75
76 float BKE_nla_tweakedit_remap(struct AnimData *adt, float cframe, short invert);
77
78 #endif
79