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