== Snap Bones To Location in PoseMode ==
[blender.git] / source / blender / blenkernel / BKE_armature.h
1 /**
2  * blenlib/BKE_armature.h (mar-2001 nzc)
3  *      
4  * $Id$ 
5  *
6  * ***** BEGIN GPL/BL DUAL 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. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
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  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34 #ifndef BKE_ARMATURE_H
35 #define BKE_ARMATURE_H
36
37 struct Bone;
38 struct Main;
39 struct bArmature;
40 struct bPose;
41 struct bPoseChannel;
42 struct bConstraint;
43 struct Object;
44 struct MDeformVert;
45 struct Mesh;
46 struct PoseTree;
47 struct ListBase;
48
49 typedef struct PoseTarget
50 {
51         struct PoseTarget *next, *prev;
52
53         struct bConstraint *con;                /* the constrait of this target */
54         int tip;                                                /* index of tip pchan in PoseTree */
55 } PoseTarget;
56
57 typedef struct PoseTree
58 {
59         struct PoseTree *next, *prev;
60
61         struct ListBase targets;                /* list of targets of the tree */
62         struct bPoseChannel     **pchan;        /* array of pose channels */
63         int             *parent;                                /* and their parents */
64         int             totchannel;                             /* number of pose channels */
65         float   (*basis_change)[3][3];  /* basis change result from solver */
66         int             iterations;                             /* iterations from the constraint */
67         int     stretch;                                /* disable stretching */
68 } PoseTree;
69
70 /*      Core armature functionality */
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 struct bArmature *add_armature(void);
75 void free_boneChildren(struct Bone *bone);
76 void free_bones (struct bArmature *arm);
77 void unlink_armature(struct bArmature *arm);
78 void free_armature(struct bArmature *arm);
79 void make_local_armature(struct bArmature *arm);
80 struct bArmature *copy_armature(struct bArmature *arm);
81 void bone_flip_name (char *name, int strip_number);
82
83 struct bArmature* get_armature (struct Object* ob);
84 struct Bone *get_named_bone (struct bArmature *arm, const char *name);
85
86 float distfactor_to_bone (float vec[3], float b1[3], float b2[3], float rad1, float rad2, float rdist);
87
88 void where_is_armature (struct bArmature *arm);
89 void where_is_armature_bone(struct Bone *bone, struct Bone *prevbone);
90 void armature_rebuild_pose(struct Object *ob, struct bArmature *arm);
91 void where_is_pose (struct Object *ob);
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_mat_pose_to_bone(struct bPoseChannel *pchan, float inmat[][4], float outmat[][4]);
101 void armature_loc_pose_to_bone(struct bPoseChannel *pchan, float *inloc, float *outloc);
102
103 /*      Animation functions */
104 struct PoseTree *ik_tree_to_posetree(struct Object *ob, struct Bone *bone);
105 void solve_posetree(PoseTree *tree);
106 void free_posetree(PoseTree *tree);
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);
114
115 #ifdef __cplusplus
116 }
117 #endif
118
119 #endif
120