Merge from trunk -r 23968:24181.
[blender.git] / source / blender / blenkernel / BKE_armature.h
1 /**
2  * blenlib/BKE_armature.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31 #ifndef BKE_ARMATURE_H
32 #define BKE_ARMATURE_H
33
34 struct Bone;
35 struct Main;
36 struct bArmature;
37 struct bPose;
38 struct bPoseChannel;
39 struct bConstraint;
40 struct Scene;
41 struct Object;
42 struct MDeformVert;
43 struct Mesh;
44 struct PoseTree;
45 struct ListBase;
46
47 typedef struct PoseTarget
48 {
49         struct PoseTarget *next, *prev;
50
51         struct bConstraint *con;                /* the constrait of this target */
52         int tip;                                                /* index of tip pchan in PoseTree */
53 } PoseTarget;
54
55 typedef struct PoseTree
56 {
57         struct PoseTree *next, *prev;
58
59         struct ListBase targets;                /* list of targets of the tree */
60         struct bPoseChannel     **pchan;        /* array of pose channels */
61         int             *parent;                                /* and their parents */
62         int             totchannel;                             /* number of pose channels */
63         float   (*basis_change)[3][3];  /* basis change result from solver */
64         int             iterations;                             /* iterations from the constraint */
65         int     stretch;                                /* disable stretching */
66 } PoseTree;
67
68 /*      Core armature functionality */
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72
73 struct bArmature *add_armature(char *name);
74 struct bArmature *get_armature(struct Object *ob);
75 void free_bonelist (struct ListBase *lb);
76 void free_armature(struct bArmature *arm);
77 void make_local_armature(struct bArmature *arm);
78 struct bArmature *copy_armature(struct bArmature *arm);
79
80 void bone_flip_name (char *name, int strip_number);
81 void bone_autoside_name (char *name, int strip_number, short axis, float head, float tail);
82
83 struct Bone *get_named_bone (struct bArmature *arm, const char *name);
84
85 float distfactor_to_bone (float vec[3], float b1[3], float b2[3], float rad1, float rad2, float rdist);
86
87 void where_is_armature (struct bArmature *arm);
88 void where_is_armature_bone(struct Bone *bone, struct Bone *prevbone);
89 void armature_rebuild_pose(struct Object *ob, struct bArmature *arm);
90 void where_is_pose (struct Scene *scene, struct Object *ob);
91 void where_is_pose_bone(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime);
92
93 /* get_objectspace_bone_matrix has to be removed still */
94 void get_objectspace_bone_matrix (struct Bone* bone, float M_accumulatedMatrix[][4], int root, int posed);
95 void vec_roll_to_mat3(float *vec, float roll, float mat[][3]);
96 void mat3_to_vec_roll(float mat[][3], float *vec, float *roll);
97
98 /* Common Conversions Between Co-ordinate Spaces */
99 void armature_mat_world_to_pose(struct Object *ob, float inmat[][4], float outmat[][4]);
100 void armature_loc_world_to_pose(struct Object *ob, float *inloc, float *outloc);
101 void armature_mat_pose_to_bone(struct bPoseChannel *pchan, float inmat[][4], float outmat[][4]);
102 void armature_loc_pose_to_bone(struct bPoseChannel *pchan, float *inloc, float *outloc);
103 void armature_mat_pose_to_delta(float delta_mat[][4], float pose_mat[][4], float arm_mat[][4]);
104
105 /* Rotation Mode Conversions - Used for PoseChannels + Objects... */
106 void BKE_rotMode_change_values(float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode);
107
108 /* B-Bone support */
109 typedef struct Mat4 {
110         float mat[4][4];
111 } Mat4;
112
113 Mat4 *b_bone_spline_setup(struct bPoseChannel *pchan, int rest);
114
115 #ifdef __cplusplus
116 }
117 #endif
118
119 #endif
120