svn merge -r 15392:15551 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[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 };
53
54 /* Macros for easier/more consistant state testing */
55 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED)==0)
56 #define EXPANDED_AGRP(agrp) (agrp->flag & AGRP_EXPANDED)
57 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
58
59 #define VISIBLE_ACHAN(achan) ((achan->flag & ACHAN_HIDDEN)==0)
60 #define EDITABLE_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && ((achan->flag & ACHAN_PROTECTED)==0))
61 #define EXPANDED_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && (achan->flag & ACHAN_EXPANDED))
62 #define SEL_ACHAN(achan) ((achan->flag & ACHAN_SELECTED) || (achan->flag & ACHAN_HILIGHTED))
63 #define FILTER_IPO_ACHAN(achan) ((achan->flag & ACHAN_SHOWIPO))
64 #define FILTER_CON_ACHAN(achan) ((achan->flag & ACHAN_SHOWCONS))
65
66 #define EDITABLE_CONCHAN(conchan) ((conchan->flag & CONSTRAINT_CHANNEL_PROTECTED)==0)
67 #define SEL_CONCHAN(conchan) (conchan->flag & CONSTRAINT_CHANNEL_SELECT)
68
69 #define EDITABLE_ICU(icu) ((icu->flag & IPO_PROTECT)==0)
70 #define SEL_ICU(icu) (icu->flag & IPO_SELECT)
71
72 #define NLA_ACTION_SCALED (G.saction->pin==0 && OBACT && OBACT->action)
73 #define NLA_IPO_SCALED (OBACT && OBACT->action && G.sipo->pin==0 && G.sipo->actname)
74
75 /* constants for setting ipo-interpolation type */
76 enum {
77         SET_IPO_MENU = -1,
78         SET_IPO_POPUP = 0,
79         
80         SET_IPO_CONSTANT,
81         SET_IPO_LINEAR,
82         SET_IPO_BEZIER,
83 };
84
85 /* constants for setting ipo-extrapolation type */
86 enum {
87         SET_EXTEND_MENU = 9,
88         SET_EXTEND_POPUP = 10,
89         
90         SET_EXTEND_CONSTANT,
91         SET_EXTEND_EXTRAPOLATION,
92         SET_EXTEND_CYCLIC,
93         SET_EXTEND_CYCLICEXTRAPOLATION
94 };
95
96 /* constants for channel rearranging */
97 /* WARNING: don't change exising ones without modifying rearrange func accordingly */
98 enum {
99         REARRANGE_ACTCHAN_TOP= -2,
100         REARRANGE_ACTCHAN_UP= -1,
101         REARRANGE_ACTCHAN_DOWN= 1,
102         REARRANGE_ACTCHAN_BOTTOM= 2
103 };
104
105
106 struct bAction;
107 struct bActionChannel;
108 struct bActionGroup;
109 struct bPose;
110 struct bPoseChannel;
111 struct Object;
112 struct Ipo;
113 struct BWinEvent;
114 struct Key;
115 struct ListBase;
116 struct TimeMarker;
117
118 /* Key operations */
119 void transform_action_keys(int mode, int dummy);
120 void duplicate_action_keys(void);
121 void snap_cfra_action(void);
122 void snap_action_keys(short mode);
123 void mirror_action_keys(short mode);
124 void insertkey_action(void);
125 void delete_action_keys(void);
126 void delete_action_channels(void);
127 void clean_action(void);
128 void sample_action_keys(void);
129
130 /* Column/Channel Key select */
131 void column_select_action_keys(int mode);
132 void selectall_action_keys(short mval[], short mode, short selectmode);
133 void markers_selectkeys_between(void);
134 void nextprev_action_keyframe(short dir);
135
136 /* Action Data Copying */
137 void free_actcopybuf(void);
138 void copy_actdata(void);
139 void paste_actdata(void);
140
141 /* Group/Channel Operations */
142 struct bActionGroup *get_active_actiongroup(struct bAction *act);
143 void set_active_actiongroup(struct bAction *act, struct bActionGroup *agrp, short select);
144 void actionbone_group_copycolors(struct bActionGroup *grp, short init_new);
145 void verify_pchan2achan_grouping(struct bAction *act, struct bPose *pose, char name[]);
146 void sync_pchan2achan_grouping(void); 
147 void action_groups_group(short add_group);
148 void action_groups_ungroup(void);
149
150 /* Channel/Strip Operations */
151 void rearrange_action_channels(short mode);
152
153 void expand_all_action(void);
154 void expand_obscuregroups_action(void);
155 void openclose_level_action(short mode);
156 void setflag_action_channels(short mode);
157
158 /* IPO/Handle Types  */
159 void sethandles_action_keys(int code);
160 void action_set_ipo_flags(short mode, short event);
161
162 /* Select */
163 void borderselect_action(void);
164 void borderselect_actionchannels(void);
165 void deselect_action_keys(short test, short sel);
166 void deselect_action_channels(short mode);
167 void deselect_actionchannels(struct bAction *act, short mode);
168 int select_channel(struct bAction *act, struct bActionChannel *achan, int selectmode);
169 void select_actionchannel_by_name(struct bAction *act, char *name, int select);
170 void select_action_group_channels(struct bAction *act, struct bActionGroup *agrp);
171 void selectkeys_leftright (short leftright, short select_mode);
172
173 /* Action Markers */
174 void action_set_activemarker(struct bAction *act, struct TimeMarker *active, short deselect);
175 void action_add_localmarker(struct bAction *act, int frame);
176 void action_rename_localmarker(struct bAction *act);
177 void action_remove_localmarkers(struct bAction *act);
178
179 /* ShapeKey stuff */
180 struct Key *get_action_mesh_key(void);
181 int get_nearest_key_num(struct Key *key, short *mval, float *x);
182
183 void *get_nearest_act_channel(short mval[], short *ret_type);
184
185 /* Action */
186 struct bActionChannel *get_hilighted_action_channel(struct bAction* action);
187 struct bAction *add_empty_action(char *name);
188 struct bAction *ob_get_action(struct Object *ob);
189
190 void actdata_filter(ListBase *act_data, int filter_mode, void *data, short datatype);
191 void *get_action_context(short *datatype);
192
193 void remake_action_ipos(struct bAction *act);
194 void action_previewrange_set(struct bAction *act);
195
196 /* event handling */
197 void winqreadactionspace(struct ScrArea *sa, void *spacedata, struct BWinEvent *evt);
198
199 #endif
200