== Action/Pose Groups - Keyframing Integration ==
[blender.git] / source / blender / include / BIF_editaction.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): 2007, Joshua Leung, Action Editor Recode
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32
33 #ifndef BIF_EDITACTION_H
34 #define BIF_EDITACTION_H
35
36 /* some interface related sizes*/
37 #define CHANNELHEIGHT   16
38 #define CHANNELSKIP             2
39 #define NAMEWIDTH       164
40 #define SLIDERWIDTH     125
41 #define ACTWIDTH                (G.saction->actwidth)
42
43 /* Some types for easier type-testing */
44 enum {
45         ACTTYPE_NONE= 0,
46         ACTTYPE_GROUP,
47         ACTTYPE_ACHAN,
48         ACTTYPE_CONCHAN,
49         ACTTYPE_ICU,
50         ACTTYPE_FILLIPO,
51         ACTTYPE_FILLCON,
52         ACTTYPE_IPO,
53         ACTTYPE_SHAPEKEY
54 };
55
56 /* Macros for easier/more consistant state testing */
57 #define EDITABLE_AGRP(agrp) ((agrp->flag & AGRP_PROTECTED)==0)
58 #define EXPANDED_AGRP(agrp) (agrp->flag & AGRP_EXPANDED)
59 #define SEL_AGRP(agrp) ((agrp->flag & AGRP_SELECTED) || (agrp->flag & AGRP_ACTIVE))
60
61 #define VISIBLE_ACHAN(achan) ((achan->flag & ACHAN_HIDDEN)==0)
62 #define EDITABLE_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && ((achan->flag & ACHAN_PROTECTED)==0))
63 #define EXPANDED_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && (achan->flag & ACHAN_EXPANDED))
64 #define SEL_ACHAN(achan) ((achan->flag & ACHAN_SELECTED) || (achan->flag & ACHAN_HILIGHTED))
65 #define FILTER_IPO_ACHAN(achan) ((achan->flag & ACHAN_SHOWIPO))
66 #define FILTER_CON_ACHAN(achan) ((achan->flag & ACHAN_SHOWCONS))
67
68 #define EDITABLE_CONCHAN(conchan) ((conchan->flag & CONSTRAINT_CHANNEL_PROTECTED)==0)
69 #define SEL_CONCHAN(conchan) (conchan->flag & CONSTRAINT_CHANNEL_SELECT)
70
71 #define EDITABLE_ICU(icu) ((icu->flag & IPO_PROTECT)==0)
72 #define SEL_ICU(icu) (icu->flag & IPO_SELECT)
73
74 #define NLA_ACTION_SCALED (G.saction->pin==0 && OBACT && OBACT->action)
75 #define NLA_IPO_SCALED (OBACT && OBACT->action && G.sipo->pin==0 && G.sipo->actname)
76
77 /* constants for setting ipo-interpolation type */
78 enum {
79         SET_IPO_MENU = -1,
80         SET_IPO_POPUP = 0,
81         
82         SET_IPO_CONSTANT,
83         SET_IPO_LINEAR,
84         SET_IPO_BEZIER,
85 };
86
87 /* constants for setting ipo-extrapolation type */
88 enum {
89         SET_EXTEND_MENU = 9,
90         SET_EXTEND_POPUP = 10,
91         
92         SET_EXTEND_CONSTANT,
93         SET_EXTEND_EXTRAPOLATION,
94         SET_EXTEND_CYCLIC,
95         SET_EXTEND_CYCLICEXTRAPOLATION
96 };
97
98 /* constants for channel rearranging */
99 /* WARNING: don't change exising ones without modifying rearrange func accordingly */
100 enum {
101         REARRANGE_ACTCHAN_TOP= -2,
102         REARRANGE_ACTCHAN_UP= -1,
103         REARRANGE_ACTCHAN_DOWN= 1,
104         REARRANGE_ACTCHAN_BOTTOM= 2
105 };
106
107
108 struct bAction;
109 struct bActionChannel;
110 struct bActionGroup;
111 struct bPose;
112 struct bPoseChannel;
113 struct Object;
114 struct Ipo;
115 struct BWinEvent;
116 struct Key;
117 struct ListBase;
118 struct TimeMarker;
119
120 /* Key operations */
121 void transform_action_keys(int mode, int dummy);
122 void duplicate_action_keys(void);
123 void snap_cfra_action(void);
124 void snap_action_keys(short mode);
125 void mirror_action_keys(short mode);
126 void insertkey_action(void);
127 void delete_action_keys(void);
128 void delete_action_channels(void);
129 void clean_action(void);
130 void sample_action_keys(void);
131
132 /* Column/Channel Key select */
133 void column_select_action_keys(int mode);
134 void selectall_action_keys(short mval[], short mode, short selectmode);
135 void markers_selectkeys_between(void);
136 void nextprev_action_keyframe(short dir);
137
138 /* Action Data Copying */
139 void free_actcopybuf(void);
140 void copy_actdata(void);
141 void paste_actdata(void);
142
143 /* Group/Channel Operations */
144 struct bActionGroup *get_active_actiongroup(struct bAction *act);
145 void set_active_actiongroup(struct bAction *act, struct bActionGroup *agrp, short select);
146 void verify_pchan2achan_grouping(struct bAction *act, struct bPose *pose, char name[]); 
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 openclose_level_action(short mode);
155
156 /* IPO/Handle Types  */
157 void sethandles_action_keys(int code);
158 void action_set_ipo_flags(short mode, short event);
159
160 /* Select */
161 void borderselect_action(void);
162 void deselect_action_keys(short test, short sel);
163 void deselect_action_channels(short test);
164 void deselect_actionchannels(struct bAction *act, short test);
165 int select_channel(struct bAction *act, struct bActionChannel *achan, int selectmode);
166 void select_actionchannel_by_name(struct bAction *act, char *name, int select);
167 void selectkeys_leftright (short leftright, short select_mode);
168
169 /* Action Markers */
170 void action_set_activemarker(struct bAction *act, struct TimeMarker *active, short deselect);
171 void action_add_localmarker(struct bAction *act, int frame);
172 void action_rename_localmarker(struct bAction *act);
173 void action_remove_localmarkers(struct bAction *act);
174
175 /* ShapeKey stuff */
176 struct Key *get_action_mesh_key(void);
177 int get_nearest_key_num(struct Key *key, short *mval, float *x);
178
179 void *get_nearest_act_channel(short mval[], short *ret_type);
180
181 /* Action */
182 struct bActionChannel *get_hilighted_action_channel(struct bAction* action);
183 struct bAction *add_empty_action(char *name);
184 struct bAction *ob_get_action(struct Object *ob);
185
186 void actdata_filter(ListBase *act_data, int filter_mode, void *data, short datatype);
187 void *get_action_context(short *datatype);
188
189 void remake_action_ipos(struct bAction *act);
190
191 /* event handling */
192 void winqreadactionspace(struct ScrArea *sa, void *spacedata, struct BWinEvent *evt);
193
194 #endif
195