== Action Editor - Copy and Paste Tools ==
[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_ACHAN,
47         ACTTYPE_CONCHAN,
48         ACTTYPE_ICU,
49         ACTTYPE_FILLIPO,
50         ACTTYPE_FILLCON,
51         ACTTYPE_IPO,
52         ACTTYPE_SHAPEKEY
53 };
54
55 /* Macros for easier/more consistant state testing */
56 #define VISIBLE_ACHAN(achan) ((achan->flag & ACHAN_HIDDEN)==0)
57 #define EDITABLE_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && ((achan->flag & ACHAN_PROTECTED)==0))
58 #define EXPANDED_ACHAN(achan) ((VISIBLE_ACHAN(achan)) && (achan->flag & ACHAN_EXPANDED))
59 #define SEL_ACHAN(achan) ((achan->flag & ACHAN_SELECTED) || (achan->flag & ACHAN_HILIGHTED))
60 #define FILTER_IPO_ACHAN(achan) ((achan->flag & ACHAN_SHOWIPO))
61 #define FILTER_CON_ACHAN(achan) ((achan->flag & ACHAN_SHOWCONS))
62
63 #define EDITABLE_CONCHAN(conchan) ((conchan->flag & CONSTRAINT_CHANNEL_PROTECTED)==0)
64 #define SEL_CONCHAN(conchan) (conchan->flag & CONSTRAINT_CHANNEL_SELECT)
65
66 #define EDITABLE_ICU(icu) ((icu->flag & IPO_PROTECT)==0)
67 #define SEL_ICU(icu) (icu->flag & IPO_SELECT)
68
69 #define NLA_ACTION_SCALED (G.saction->pin==0 && OBACT && OBACT->action)
70 #define NLA_IPO_SCALED (OBACT && OBACT->action && G.sipo->pin==0 && G.sipo->actname)
71
72 /* constants for setting ipo-interpolation type */
73 enum {
74         SET_IPO_MENU = -1,
75         SET_IPO_POPUP = 0,
76         
77         SET_IPO_CONSTANT,
78         SET_IPO_LINEAR,
79         SET_IPO_BEZIER,
80 };
81
82 /* constants for setting ipo-extrapolation type */
83 enum {
84         
85         SET_EXTEND_MENU = 9,
86         SET_EXTEND_POPUP = 10,
87         
88         SET_EXTEND_CONSTANT,
89         SET_EXTEND_EXTRAPOLATION,
90         SET_EXTEND_CYCLIC,
91         SET_EXTEND_CYCLICEXTRAPOLATION
92 };
93
94
95 struct bAction;
96 struct bActionChannel;
97 struct bPoseChannel;
98 struct Object;
99 struct Ipo;
100 struct BWinEvent;
101 struct Key;
102 struct ListBase;
103
104 /* Key operations */
105 void transform_action_keys(int mode, int dummy);
106 void duplicate_action_keys(void);
107 void snap_action_keys(short mode);
108 void mirror_action_keys(short mode);
109 void insertkey_action(void);
110 void delete_action_keys(void);
111 void delete_action_channels(void);
112 void clean_action(void);
113
114 /* Column/Channel Key select */
115 void column_select_action_keys(int mode);
116 void selectall_action_keys(short mval[], short mode, short selectmode);
117 void markers_selectkeys_between(void);
118
119 /* Action Data Copying */
120 void free_actcopybuf(void);
121 void copy_actdata(void);
122 void paste_actdata(void);
123
124 /* channel/strip operations */
125 void up_sel_action(void);
126 void down_sel_action(void);
127 void top_sel_action(void);
128 void bottom_sel_action(void);
129
130 /* IPO/Handle Types  */
131 void sethandles_action_keys(int code);
132 void action_set_ipo_flags(short mode, short event);
133
134 /* Select */
135 void borderselect_action(void);
136 void deselect_action_keys(short test, short sel);
137 void deselect_action_channels(short test);
138 void deselect_actionchannels(struct bAction *act, short test);
139 int select_channel(struct bAction *act, struct bActionChannel *achan, int selectmode);
140 void select_actionchannel_by_name(struct bAction *act, char *name, int select);
141
142 /* ShapeKey stuff */
143 struct Key *get_action_mesh_key(void);
144 int get_nearest_key_num(struct Key *key, short *mval, float *x);
145
146 void *get_nearest_act_channel(short mval[], short *ret_type);
147
148 /* Action */
149 struct bActionChannel *get_hilighted_action_channel(struct bAction* action);
150 struct bAction *add_empty_action(char *name);
151 struct bAction *ob_get_action(struct Object *ob);
152
153 void actdata_filter(ListBase *act_data, int filter_mode, void *data, short datatype);
154 void *get_action_context(short *datatype);
155
156 void remake_action_ipos(struct bAction *act);
157
158 /* event handling */
159 void winqreadactionspace(struct ScrArea *sa, void *spacedata, struct BWinEvent *evt);
160
161 #endif
162