soc-2008-mxcurioni: merged changes to revision 15705
[blender.git] / source / blender / include / BIF_editaction.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) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): 2007, Joshua Leung, Action Editor Recode
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30 #ifndef BIF_EDITACTION_H
31 #define BIF_EDITACTION_H
32
33 /* some interface related sizes*/
34 #define CHANNELHEIGHT   16
35 #define CHANNELSKIP             2
36 #define NAMEWIDTH       164
37 #define SLIDERWIDTH     125
38 #define ACTWIDTH                (G.saction->actwidth)
39
40 /* Some types for easier type-testing */
41 enum {
42         ACTTYPE_NONE= 0,
43         ACTTYPE_GROUP,
44         ACTTYPE_ACHAN,
45         ACTTYPE_CONCHAN,
46         ACTTYPE_CONCHAN2,
47         ACTTYPE_ICU,
48         ACTTYPE_FILLIPO,
49         ACTTYPE_FILLCON,
50         ACTTYPE_IPO,
51         ACTTYPE_SHAPEKEY,
52         ACTTYPE_GPLAYER
53 };
54
55 /* Macros for easier/more consistant state testing */
56 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED)==0)
57 #define EXPANDED_AGRP(agrp) (agrp->flag & AGRP_EXPANDED)
58 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
59
60 #define VISIBLE_ACHAN(achan) ((achan->flag & ACHAN_HIDDEN)==0)
61 #define EDITABLE_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && ((achan->flag & ACHAN_PROTECTED)==0))
62 #define EXPANDED_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && (achan->flag & ACHAN_EXPANDED))
63 #define SEL_ACHAN(achan) ((achan->flag & ACHAN_SELECTED) || (achan->flag & ACHAN_HILIGHTED))
64 #define FILTER_IPO_ACHAN(achan) ((achan->flag & ACHAN_SHOWIPO))
65 #define FILTER_CON_ACHAN(achan) ((achan->flag & ACHAN_SHOWCONS))
66
67 #define EDITABLE_CONCHAN(conchan) ((conchan->flag & CONSTRAINT_CHANNEL_PROTECTED)==0)
68 #define SEL_CONCHAN(conchan) (conchan->flag & CONSTRAINT_CHANNEL_SELECT)
69
70 #define EDITABLE_ICU(icu) ((icu->flag & IPO_PROTECT)==0)
71 #define SEL_ICU(icu) (icu->flag & IPO_SELECT)
72
73 #define EDITABLE_GPL(gpl) ((gpl->flag & GP_LAYER_LOCKED)==0)
74 #define SEL_GPL(gpl) ((gpl->flag & GP_LAYER_ACTIVE) || (gpl->flag & GP_LAYER_SELECT))
75
76 #define NLA_ACTION_SCALED (G.saction->mode==SACTCONT_ACTION && G.saction->pin==0 && OBACT && OBACT->action)
77 #define NLA_IPO_SCALED (OBACT && OBACT->action && G.sipo->pin==0 && G.sipo->actname)
78
79 /* constants for setting ipo-interpolation type */
80 enum {
81         SET_IPO_MENU = -1,
82         SET_IPO_POPUP = 0,
83         
84         SET_IPO_CONSTANT,
85         SET_IPO_LINEAR,
86         SET_IPO_BEZIER,
87 };
88
89 /* constants for setting ipo-extrapolation type */
90 enum {
91         SET_EXTEND_MENU = 9,
92         SET_EXTEND_POPUP = 10,
93         
94         SET_EXTEND_CONSTANT,
95         SET_EXTEND_EXTRAPOLATION,
96         SET_EXTEND_CYCLIC,
97         SET_EXTEND_CYCLICEXTRAPOLATION
98 };
99
100 /* constants for channel rearranging */
101 /* WARNING: don't change exising ones without modifying rearrange func accordingly */
102 enum {
103         REARRANGE_ACTCHAN_TOP= -2,
104         REARRANGE_ACTCHAN_UP= -1,
105         REARRANGE_ACTCHAN_DOWN= 1,
106         REARRANGE_ACTCHAN_BOTTOM= 2
107 };
108
109
110 struct bAction;
111 struct bActionChannel;
112 struct bActionGroup;
113 struct bPose;
114 struct bPoseChannel;
115 struct Object;
116 struct Ipo;
117 struct BWinEvent;
118 struct Key;
119 struct ListBase;
120 struct TimeMarker;
121 struct bGPdata;
122 struct bGPDlayer;
123
124 /* Key operations */
125 void transform_action_keys(int mode, int dummy);
126 void duplicate_action_keys(void);
127 void snap_cfra_action(void);
128 void snap_action_keys(short mode);
129 void mirror_action_keys(short mode);
130 void insertkey_action(void);
131 void delete_action_keys(void);
132 void delete_action_channels(void);
133 void clean_action(void);
134 void sample_action_keys(void);
135
136 /* Column/Channel Key select */
137 void column_select_action_keys(int mode);
138 void selectall_action_keys(short mval[], short mode, short selectmode);
139 void markers_selectkeys_between(void);
140 void nextprev_action_keyframe(short dir);
141
142 /* Action Data Copying */
143 void free_actcopybuf(void);
144 void copy_actdata(void);
145 void paste_actdata(void);
146
147 /* Group/Channel Operations */
148 struct bActionGroup *get_active_actiongroup(struct bAction *act);
149 void set_active_actiongroup(struct bAction *act, struct bActionGroup *agrp, short select);
150 void actionbone_group_copycolors(struct bActionGroup *grp, short init_new);
151 void verify_pchan2achan_grouping(struct bAction *act, struct bPose *pose, char name[]);
152 void sync_pchan2achan_grouping(void); 
153 void action_groups_group(short add_group);
154 void action_groups_ungroup(void);
155
156 /* Channel/Strip Operations */
157 void rearrange_action_channels(short mode);
158
159 void expand_all_action(void);
160 void expand_obscuregroups_action(void);
161 void openclose_level_action(short mode);
162 void setflag_action_channels(short mode);
163
164 /* IPO/Handle Types  */
165 void sethandles_action_keys(int code);
166 void action_set_ipo_flags(short mode, short event);
167
168 /* Select */
169 void borderselect_action(void);
170 void borderselect_actionchannels(void);
171 void deselect_action_keys(short test, short sel);
172 void deselect_action_channels(short mode);
173 void deselect_actionchannels(struct bAction *act, short mode);
174 int select_channel(struct bAction *act, struct bActionChannel *achan, int selectmode);
175 void select_actionchannel_by_name(struct bAction *act, char *name, int select);
176 void select_action_group_channels(struct bAction *act, struct bActionGroup *agrp);
177 void selectkeys_leftright (short leftright, short select_mode);
178
179 /* Action Markers */
180 void action_set_activemarker(struct bAction *act, struct TimeMarker *active, short deselect);
181 void action_add_localmarker(struct bAction *act, int frame);
182 void action_rename_localmarker(struct bAction *act);
183 void action_remove_localmarkers(struct bAction *act);
184
185 /* Grease-Pencil Data */
186 void gplayer_make_cfra_list(struct bGPDlayer *gpl, ListBase *elems, short onlysel);
187
188 void deselect_gpencil_layers(struct bGPdata *gpd, short select_mode);
189
190 short is_gplayer_frame_selected(struct bGPDlayer *gpl);
191 void set_gplayer_frame_selection(struct bGPDlayer *gpl, short mode);
192 void select_gpencil_frames(struct bGPDlayer *gpl, short select_mode);
193 void select_gpencil_frame(struct bGPDlayer *gpl, int selx, short select_mode);
194 void borderselect_gplayer_frames(struct bGPDlayer *gpl, float min, float max, short select_mode);
195
196 void delete_gpencil_layers(void);
197 void delete_gplayer_frames(struct bGPDlayer *gpl);
198 void duplicate_gplayer_frames(struct bGPDlayer *gpd);
199
200 void snap_gplayer_frames(struct bGPDlayer *gpl, short mode);
201 void mirror_gplayer_frames(struct bGPDlayer *gpl, short mode);
202
203 /* ShapeKey stuff */
204 struct Key *get_action_mesh_key(void);
205 int get_nearest_key_num(struct Key *key, short *mval, float *x);
206
207 void *get_nearest_act_channel(short mval[], short *ret_type);
208
209 /* Action */
210 struct bActionChannel *get_hilighted_action_channel(struct bAction* action);
211 struct bAction *add_empty_action(char *name);
212 struct bAction *ob_get_action(struct Object *ob);
213
214 void actdata_filter(ListBase *act_data, int filter_mode, void *data, short datatype);
215 void *get_action_context(short *datatype);
216
217 void remake_action_ipos(struct bAction *act);
218 void action_previewrange_set(struct bAction *act);
219
220 /* event handling */
221 void winqreadactionspace(struct ScrArea *sa, void *spacedata, struct BWinEvent *evt);
222
223 #endif
224