Merged 15170:15635 from trunk (no conflicts or even merges)
[blender.git] / source / blender / blenkernel / BKE_action.h
1 /*  BKE_action.h   May 2001
2  *  
3  *  Blender kernel action functionality
4  *
5  *      Reevan McKay
6  *
7  * $Id$
8  *
9  * ***** BEGIN GPL LICENSE BLOCK *****
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
29  *
30  * ***** END GPL LICENSE BLOCK *****
31  */
32
33 #ifndef BKE_ACTION_H
34 #define BKE_ACTION_H
35
36 #include "DNA_listBase.h"
37
38 /**
39  * The following structures are defined in DNA_action_types.h
40  */
41
42 struct bAction;
43 struct bActionChannel;
44 struct bPose;
45 struct bPoseChannel;
46 struct Object;
47 struct ID;
48
49 /* Kernel prototypes */
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53
54         
55 /**
56  * Removes and deallocates all channels from a pose.
57  * Does not free the pose itself.
58  */
59 void free_pose_channels(struct bPose *pose);
60
61 /** 
62  * Removes and deallocates all data from a pose, and also frees the pose.
63  */
64 void free_pose(struct bPose *pose);
65
66 /**
67  * Allocate a new pose on the heap, and copy the src pose and it's channels
68  * into the new pose. *dst is set to the newly allocated structure, and assumed to be NULL.
69  */ 
70 void copy_pose(struct bPose **dst, struct bPose *src,
71                            int copyconstraints);
72
73 /**
74  * Deallocate the action's channels including constraint channels.
75  * does not free the action structure.
76  */
77 void free_action(struct bAction * id);
78
79 void make_local_action(struct bAction *act);
80
81 /* only for armatures, doing pose actions only too */
82 void do_all_pose_actions(struct Object *);
83 /* only for objects, doing only 1 channel */
84 void do_all_object_actions(struct Object *);
85 /* only for Mesh, Curve, Surface, Lattice, doing only Shape channel */
86 void do_all_shape_actions(struct Object *);
87
88
89 /**
90  * Return a pointer to the pose channel of the given name
91  * from this pose.
92  */
93 struct  bPoseChannel *get_pose_channel(const struct bPose *pose,
94                                                                            const char *name);
95
96 /** 
97  * Looks to see if the channel with the given name
98  * already exists in this pose - if not a new one is
99  * allocated and initialized.
100  */
101 struct bPoseChannel *verify_pose_channel(struct bPose* pose, 
102                                                                                  const char* name);
103
104 /* sets constraint flags */
105 void update_pose_constraint_flags(struct bPose *pose);
106
107 /* clears BONE_UNKEYED flags for frame changing */
108 void framechange_poses_clear_unkeyed(void);
109
110 /**
111  * Allocate a new bAction on the heap and copy 
112  * the contents of src into it. If src is NULL NULL is returned.
113  */
114
115 struct bAction *copy_action(struct bAction *src);
116
117 /**
118  * Some kind of bounding box operation on the action.
119  */
120 void calc_action_range(const struct bAction *act, float *start, float *end, int incl_hidden);
121
122 /**
123  * Set the pose channels from the given action.
124  */
125 void extract_pose_from_action(struct bPose *pose, struct bAction *act, float ctime);
126
127 /**
128  * Get the effects of the given action using a workob 
129  */
130 void what_does_obaction(struct Object *ob, struct bAction *act, float cframe);
131
132 /**
133  * Iterate through the action channels of the action
134  * and return the channel with the given name.
135  * Returns NULL if no channel.
136  */
137 struct bActionChannel *get_action_channel(struct bAction *act,  const char *name);
138 /**
139  * Iterate through the action channels of the action
140  * and return the channel with the given name.
141  * Returns and adds new channel if no channel.
142  */
143 struct bActionChannel *verify_action_channel(struct bAction *act, const char *name);
144
145   /* baking */
146 struct bAction *bake_obIPO_to_action(struct Object *ob);
147
148 /* exported for game engine */
149 void blend_poses(struct bPose *dst, struct bPose *src, float srcweight, short mode);
150 void extract_pose_from_pose(struct bPose *pose, const struct bPose *src);
151
152 /* for proxy */
153 void copy_pose_result(struct bPose *to, struct bPose *from);
154 /* clear all transforms */
155 void rest_pose(struct bPose *pose);
156
157 /* map global time (frame nr) to strip converted time, doesn't clip */
158 float get_action_frame(struct Object *ob, float cframe);
159 /* map strip time to global time (frame nr)  */
160 float get_action_frame_inv(struct Object *ob, float cframe);
161 /* builds a list of NlaIpoChannel with ipo values to write in datablock */
162 void extract_ipochannels_from_action(ListBase *lb, struct ID *id, struct bAction *act, char *name, float ctime);
163 /* write values returned by extract_ipochannels_from_action, returns the number of value written */
164 int execute_ipochannels(ListBase *lb);
165
166 #ifdef __cplusplus
167 };
168 #endif
169
170 #endif
171