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