DRW: Use USHORT for vertex color and upload them in linear color to the GPU
[blender.git] / source / blender / blenkernel / BKE_action.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_ACTION_H__
21 #define __BKE_ACTION_H__
22
23 /** \file
24  * \ingroup bke
25  * \brief Blender kernel action and pose functionality.
26  */
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31
32 #include "DNA_listBase.h"
33
34 /* The following structures are defined in DNA_action_types.h, and DNA_anim_types.h */
35 struct FCurve;
36 struct Main;
37 struct Object;
38 struct bAction;
39 struct bActionGroup;
40 struct bItasc;
41 struct bPose;
42 struct bPoseChannel;
43 struct bPoseChannel_Runtime;
44
45 /* Action Lib Stuff ----------------- */
46
47 /* Allocate a new bAction with the given name */
48 struct bAction *BKE_action_add(struct Main *bmain, const char name[]);
49
50 void BKE_action_copy_data(struct Main *bmain,
51                           struct bAction *act_dst,
52                           const struct bAction *act_src,
53                           const int flag);
54 /* Allocate a copy of the given Action and all its data */
55 struct bAction *BKE_action_copy(struct Main *bmain, const struct bAction *act_src);
56
57 /* Deallocate all of the Action's data, but not the Action itself */
58 void BKE_action_free(struct bAction *act);
59
60 void BKE_action_make_local(struct Main *bmain, struct bAction *act, const bool lib_local);
61
62 /* Action API ----------------- */
63
64 /* types of transforms applied to the given item
65  * - these are the return flags for action_get_item_transforms()
66  */
67 typedef enum eAction_TransformFlags {
68   /* location */
69   ACT_TRANS_LOC = (1 << 0),
70   /* rotation */
71   ACT_TRANS_ROT = (1 << 1),
72   /* scaling */
73   ACT_TRANS_SCALE = (1 << 2),
74
75   /* bbone shape - for all the parameters, provided one is set */
76   ACT_TRANS_BBONE = (1 << 3),
77
78   /* strictly not a transform, but custom properties are also
79    * quite often used in modern rigs
80    */
81   ACT_TRANS_PROP = (1 << 4),
82
83   /* all flags */
84   ACT_TRANS_ONLY = (ACT_TRANS_LOC | ACT_TRANS_ROT | ACT_TRANS_SCALE),
85   ACT_TRANS_ALL = (ACT_TRANS_ONLY | ACT_TRANS_PROP),
86 } eAction_TransformFlags;
87
88 /* Return flags indicating which transforms the given object/posechannel has
89  * - if 'curves' is provided, a list of links to these curves are also returned
90  *   whose nodes WILL NEED FREEING
91  */
92 short action_get_item_transforms(struct bAction *act,
93                                  struct Object *ob,
94                                  struct bPoseChannel *pchan,
95                                  ListBase *curves);
96
97 /* Some kind of bounding box operation on the action */
98 void calc_action_range(const struct bAction *act, float *start, float *end, short incl_modifiers);
99
100 /* Does action have any motion data at all? */
101 bool action_has_motion(const struct bAction *act);
102
103 /* Action Groups API ----------------- */
104
105 /* Get the active action-group for an Action */
106 struct bActionGroup *get_active_actiongroup(struct bAction *act);
107
108 /* Make the given Action Group the active one */
109 void set_active_action_group(struct bAction *act, struct bActionGroup *agrp, short select);
110
111 /* Sync colors used for action/bone group with theme settings */
112 void action_group_colors_sync(struct bActionGroup *grp, const struct bActionGroup *ref_grp);
113
114 /* Add a new action group with the given name to the action */
115 struct bActionGroup *action_groups_add_new(struct bAction *act, const char name[]);
116
117 /* Add given channel into (active) group  */
118 void action_groups_add_channel(struct bAction *act,
119                                struct bActionGroup *agrp,
120                                struct FCurve *fcurve);
121
122 /* Remove the given channel from all groups */
123 void action_groups_remove_channel(struct bAction *act, struct FCurve *fcu);
124
125 /* Reconstruct group channel pointers. */
126 void BKE_action_groups_reconstruct(struct bAction *act);
127
128 /* Find a group with the given name */
129 struct bActionGroup *BKE_action_group_find_name(struct bAction *act, const char name[]);
130
131 /* Clear all 'temp' flags on all groups */
132 void action_groups_clear_tempflags(struct bAction *act);
133
134 /* Pose API ----------------- */
135
136 void BKE_pose_channel_free(struct bPoseChannel *pchan);
137 void BKE_pose_channel_free_ex(struct bPoseChannel *pchan, bool do_id_user);
138
139 void BKE_pose_channel_runtime_reset(struct bPoseChannel_Runtime *runtime);
140 void BKE_pose_channel_runtime_free(struct bPoseChannel_Runtime *runtime);
141
142 void BKE_pose_channel_free_bbone_cache(struct bPoseChannel_Runtime *runtime);
143
144 void BKE_pose_channels_free(struct bPose *pose);
145 void BKE_pose_channels_free_ex(struct bPose *pose, bool do_id_user);
146
147 void BKE_pose_channels_hash_make(struct bPose *pose);
148 void BKE_pose_channels_hash_free(struct bPose *pose);
149
150 void BKE_pose_channels_remove(struct Object *ob,
151                               bool (*filter_fn)(const char *bone_name, void *user_data),
152                               void *user_data);
153
154 void BKE_pose_free_data_ex(struct bPose *pose, bool do_id_user);
155 void BKE_pose_free_data(struct bPose *pose);
156 void BKE_pose_free(struct bPose *pose);
157 void BKE_pose_free_ex(struct bPose *pose, bool do_id_user);
158 void BKE_pose_copy_data_ex(struct bPose **dst,
159                            const struct bPose *src,
160                            const int flag,
161                            const bool copy_constraints);
162 void BKE_pose_copy_data(struct bPose **dst, const struct bPose *src, const bool copy_constraints);
163 void BKE_pose_channel_copy_data(struct bPoseChannel *pchan, const struct bPoseChannel *pchan_from);
164 struct bPoseChannel *BKE_pose_channel_find_name(const struct bPose *pose, const char *name);
165 struct bPoseChannel *BKE_pose_channel_active(struct Object *ob);
166 struct bPoseChannel *BKE_pose_channel_active_or_first_selected(struct Object *ob);
167 struct bPoseChannel *BKE_pose_channel_verify(struct bPose *pose, const char *name);
168 struct bPoseChannel *BKE_pose_channel_get_mirrored(const struct bPose *pose, const char *name);
169
170 #ifndef NDEBUG
171 bool BKE_pose_channels_is_valid(const struct bPose *pose);
172 #endif
173
174 /* sets constraint flags */
175 void BKE_pose_update_constraint_flags(struct bPose *pose);
176
177 /* tag constraint flags for update */
178 void BKE_pose_tag_update_constraint_flags(struct bPose *pose);
179
180 /* return the name of structure pointed by pose->ikparam */
181 const char *BKE_pose_ikparam_get_name(struct bPose *pose);
182
183 /* allocate and initialize pose->ikparam according to pose->iksolver */
184 void BKE_pose_ikparam_init(struct bPose *pose);
185
186 /* initialize a bItasc structure with default value */
187 void BKE_pose_itasc_init(struct bItasc *itasc);
188
189 /* Checks if a bone is part of an IK chain or not */
190 bool BKE_pose_channel_in_IK_chain(struct Object *ob, struct bPoseChannel *pchan);
191
192 /* clears BONE_UNKEYED flags for frame changing */
193 // XXX to be deprecated for a more general solution in animsys...
194 void framechange_poses_clear_unkeyed(struct Main *bmain);
195
196 /* Bone Groups API --------------------- */
197
198 /* Adds a new bone-group */
199 struct bActionGroup *BKE_pose_add_group(struct bPose *pose, const char *name);
200
201 /* Remove a bone-group */
202 void BKE_pose_remove_group(struct bPose *pose, struct bActionGroup *grp, const int index);
203 /* Remove the matching bone-group from its index */
204 void BKE_pose_remove_group_index(struct bPose *pose, const int index);
205
206 /* Assorted Evaluation ----------------- */
207
208 /* Used for the Action Constraint */
209 void what_does_obaction(struct Object *ob,
210                         struct Object *workob,
211                         struct bPose *pose,
212                         struct bAction *act,
213                         char groupname[],
214                         float cframe);
215
216 /* for proxy */
217 void BKE_pose_copy_pchan_result(struct bPoseChannel *pchanto,
218                                 const struct bPoseChannel *pchanfrom);
219 bool BKE_pose_copy_result(struct bPose *to, struct bPose *from);
220 /* clear all transforms */
221 void BKE_pose_rest(struct bPose *pose);
222
223 /* Tag pose for recalc. Also tag all related data to be recalc. */
224 void BKE_pose_tag_recalc(struct Main *bmain, struct bPose *pose);
225
226 #ifdef __cplusplus
227 };
228 #endif
229
230 #endif