Orange's buglist!
[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/BL DUAL 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. The Blender
15  * Foundation also sells licenses for use in proprietary software under
16  * the Blender License.  See http://www.blender.org/BL/ for information
17  * about this.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
27  *
28  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
29  * All rights reserved.
30  *
31  * Contributor(s): Full recode, Ton Roosendaal, Crete 2005
32  *
33  * ***** END GPL/BL DUAL LICENSE BLOCK *****
34  */
35
36 #ifndef BKE_ACTION_H
37 #define BKE_ACTION_H
38
39 #include "DNA_listBase.h"
40
41 /**
42  * The following structures are defined in DNA_action_types.h
43  */
44
45 struct bAction;
46 struct bActionChannel;
47 struct bPose;
48 struct bPoseChannel;
49 struct Object;
50
51 /* Kernel prototypes */
52 #ifdef __cplusplus
53 extern "C" {
54 #endif
55
56         
57 /**
58  * Removes and deallocates all channels from a pose.
59  * Does not free the pose itself.
60  */
61 void free_pose_channels(struct bPose *pose);
62
63 /**
64  * Allocate a new pose on the heap, and copy the src pose and it's channels
65  * into the new pose. *dst is set to the newly allocated structure, and assumed to be NULL.
66  */ 
67 void copy_pose(struct bPose **dst, struct bPose *src,
68                            int copyconstraints);
69
70 /**
71  * Deallocate the action's channels including constraint channels.
72  * does not free the action structure.
73  */
74 void free_action(struct bAction * id);
75
76 void make_local_action(struct bAction *act);
77
78 /* only for armatures, doing pose actions only too */
79 void do_all_pose_actions(struct Object *);
80 /* only for objects, doing only 1 channel */
81 void do_all_object_actions(struct Object *);
82 /* only for Mesh, Curve, Surface, Lattice, doing only Shape channel */
83 void do_all_shape_actions(struct Object *);
84
85
86 /**
87  * Return a pointer to the pose channel of the given name
88  * from this pose.
89  */
90 struct  bPoseChannel *get_pose_channel(const struct bPose *pose,
91                                                                            const char *name);
92
93 /** 
94  * Looks to see if the channel with the given name
95  * already exists in this pose - if not a new one is
96  * allocated and initialized.
97  */
98 struct bPoseChannel *verify_pose_channel(struct bPose* pose, 
99                                                                                  const char* name);
100
101 /* sets constraint flags */
102 void update_pose_constraint_flags(struct bPose *pose);
103
104 /**
105  * Allocate a new bAction on the heap and copy 
106  * the contents of src into it. If src is NULL NULL is returned.
107  */
108
109 struct bAction *copy_action(struct bAction *src);
110
111 /**
112  * Some kind of bounding box operation on the action.
113  */
114 void calc_action_range(const struct bAction *act, float *start, float *end);
115
116 /**
117  * Set the pose channels from the given action.
118  */
119 void extract_pose_from_action(struct bPose *pose, struct bAction *act,
120                                                   float ctime);
121
122 /**
123  * Iterate through the action channels of the action
124  * and return the channel with the given name.
125  * Returns NULL if no channel.
126  */
127 struct bActionChannel *get_action_channel(struct bAction *act,  const char *name);
128 /**
129  * Iterate through the action channels of the action
130  * and return the channel with the given name.
131  * Returns and adds new channel if no channel.
132  */
133 struct bActionChannel *verify_action_channel(struct bAction *act, const char *name);
134
135 /* exported for game engine */
136 void blend_poses(struct bPose *dst, const struct bPose *src, float srcweight, short mode);
137 void extract_pose_from_pose(struct bPose *pose, const struct bPose *src);
138
139 /* map global time (frame nr) to strip converted time, doesn't clip */
140 float get_action_frame(struct Object *ob, float cframe);
141
142 #ifdef __cplusplus
143 };
144 #endif
145
146 /* nla strip flag */
147 enum    {
148                         POSE_BLEND              = 0,
149                         POSE_ADD
150 };
151
152 #endif
153