svn merge -r 30718:30912 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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         int     type;                                   /* type of IK that this serves (CONSTRAINT_TYPE_KINEMATIC or ..._SPLINEIK) */
60         int             totchannel;                             /* number of pose channels */
61         
62         struct ListBase targets;                /* list of targets of the tree */
63         struct bPoseChannel     **pchan;        /* array of pose channels */
64         int             *parent;                                /* and their parents */
65         
66         float   (*basis_change)[3][3];  /* basis change result from solver */
67         int             iterations;                             /* iterations from the constraint */
68         int     stretch;                                /* disable stretching */
69 } PoseTree;
70
71 /*      Core armature functionality */
72 #ifdef __cplusplus
73 extern "C" {
74 #endif
75
76 struct bArmature *add_armature(char *name);
77 struct bArmature *get_armature(struct Object *ob);
78 void free_bonelist (struct ListBase *lb);
79 void free_armature(struct bArmature *arm);
80 void make_local_armature(struct bArmature *arm);
81 struct bArmature *copy_armature(struct bArmature *arm);
82
83 int bone_autoside_name (char *name, int strip_number, short axis, float head, float tail);
84
85 struct Bone *get_named_bone (struct bArmature *arm, const char *name);
86
87 float distfactor_to_bone (float vec[3], float b1[3], float b2[3], float rad1, float rad2, float rdist);
88
89 void where_is_armature (struct bArmature *arm);
90 void where_is_armature_bone(struct Bone *bone, struct Bone *prevbone);
91 void armature_rebuild_pose(struct Object *ob, struct bArmature *arm);
92 void where_is_pose (struct Scene *scene, struct Object *ob);
93 void where_is_pose_bone(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime, int do_extra);
94
95 /* get_objectspace_bone_matrix has to be removed still */
96 void get_objectspace_bone_matrix (struct Bone* bone, float M_accumulatedMatrix[][4], int root, int posed);
97 void vec_roll_to_mat3(float *vec, float roll, float mat[][3]);
98 void mat3_to_vec_roll(float mat[][3], float *vec, float *roll);
99
100 /* Common Conversions Between Co-ordinate Spaces */
101 void armature_mat_world_to_pose(struct Object *ob, float inmat[][4], float outmat[][4]);
102 void armature_loc_world_to_pose(struct Object *ob, float *inloc, float *outloc);
103 void armature_mat_pose_to_bone(struct bPoseChannel *pchan, float inmat[][4], float outmat[][4]);
104 void armature_loc_pose_to_bone(struct bPoseChannel *pchan, float *inloc, float *outloc);
105 void armature_mat_pose_to_delta(float delta_mat[][4], float pose_mat[][4], float arm_mat[][4]);
106
107 void pchan_apply_mat4(struct bPoseChannel *pchan, float mat[][4]);
108 void pchan_to_mat4(struct bPoseChannel *pchan, float chan_mat[4][4]);
109
110 /* Rotation Mode Conversions - Used for PoseChannels + Objects... */
111 void BKE_rotMode_change_values(float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode);
112
113 /* B-Bone support */
114 typedef struct Mat4 {
115         float mat[4][4];
116 } Mat4;
117
118 Mat4 *b_bone_spline_setup(struct bPoseChannel *pchan, int rest);
119
120 #ifdef __cplusplus
121 }
122 #endif
123
124 #endif
125