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