code cleanup: move get_selected_defgroups into object_deform.c and make it behave...
[blender.git] / source / blender / blenkernel / BKE_armature.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef __BKE_ARMATURE_H__
28 #define __BKE_ARMATURE_H__
29
30 /** \file BKE_armature.h
31  *  \ingroup bke
32  *  \since March 2001
33  *  \author nzc
34  */
35
36 struct Bone;
37 struct Main;
38 struct bArmature;
39 struct bPose;
40 struct bPoseChannel;
41 struct bConstraint;
42 struct Scene;
43 struct Object;
44 struct MDeformVert;
45 struct Mesh;
46 struct PoseTree;
47 struct ListBase;
48
49 typedef struct PoseTarget {
50         struct PoseTarget *next, *prev;
51
52         struct bConstraint *con;        /* the constrait of this target */
53         int tip;                        /* index of tip pchan in PoseTree */
54 } PoseTarget;
55
56 typedef struct PoseTree {
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 *BKE_armature_add(const char *name);
77 struct bArmature *BKE_armature_from_object(struct Object *ob);
78 void BKE_armature_bonelist_free(struct ListBase *lb);
79 void BKE_armature_free(struct bArmature *arm);
80 void BKE_armature_make_local(struct bArmature *arm);
81 struct bArmature *BKE_armature_copy(struct bArmature *arm);
82
83 /* Bounding box. */
84 struct BoundBox *BKE_armature_boundbox_get(struct Object *ob);
85
86 int bone_autoside_name(char name[64], int strip_number, short axis, float head, float tail);
87
88 struct Bone *BKE_armature_find_bone_name(struct bArmature *arm, const char *name);
89
90 float distfactor_to_bone(const float vec[3], const float b1[3], const float b2[3], float r1, float r2, float rdist);
91
92 void BKE_armature_where_is(struct bArmature *arm);
93 void BKE_armature_where_is_bone(struct Bone *bone, struct Bone *prevbone);
94 void BKE_pose_rebuild(struct Object *ob, struct bArmature *arm);
95 void BKE_pose_where_is(struct Scene *scene, struct Object *ob);
96 void BKE_pose_where_is_bone(struct Scene *scene, struct Object *ob, struct bPoseChannel *pchan, float ctime, int do_extra);
97 void BKE_pose_where_is_bone_tail(struct bPoseChannel *pchan);
98
99 /* get_objectspace_bone_matrix has to be removed still */
100 void get_objectspace_bone_matrix(struct Bone *bone, float M_accumulatedMatrix[][4], int root, int posed);
101 void vec_roll_to_mat3(const float vec[3], const float roll, float mat[][3]);
102 void mat3_to_vec_roll(float mat[][3], float *vec, float *roll);
103
104 /* Common Conversions Between Co-ordinate Spaces */
105 void BKE_armature_mat_world_to_pose(struct Object *ob, float inmat[][4], float outmat[][4]);
106 void BKE_armature_loc_world_to_pose(struct Object *ob, const float inloc[3], float outloc[3]);
107 void BKE_armature_mat_pose_to_bone(struct bPoseChannel *pchan, float inmat[][4], float outmat[][4]);
108 void BKE_armature_loc_pose_to_bone(struct bPoseChannel *pchan, const float inloc[3], float outloc[3]);
109 void BKE_armature_mat_bone_to_pose(struct bPoseChannel *pchan, float inmat[][4], float outmat[][4]);
110 void BKE_armature_mat_pose_to_delta(float delta_mat[][4], float pose_mat[][4], float arm_mat[][4]);
111
112 void BKE_armature_mat_pose_to_bone_ex(struct Object *ob, struct bPoseChannel *pchan, float inmat[][4], float outmat[][4]);
113
114 void BKE_pchan_mat3_to_rot(struct bPoseChannel *pchan, float mat[][3], short use_compat);
115 void BKE_pchan_apply_mat4(struct bPoseChannel *pchan, float mat[][4], short use_comat);
116 void BKE_pchan_to_mat4(struct bPoseChannel *pchan, float chan_mat[4][4]);
117 void BKE_pchan_calc_mat(struct bPoseChannel *pchan);
118
119 /* Get the "pchan to pose" transform matrix. These matrices apply the effects of
120  * HINGE/NO_SCALE/NO_LOCAL_LOCATION options over the pchan loc/rot/scale transformations. */
121 void BKE_pchan_to_pose_mat(struct bPoseChannel *pchan, float rotscale_mat[][4], float loc_mat[][4]);
122
123 /* Rotation Mode Conversions - Used for PoseChannels + Objects... */
124 void BKE_rotMode_change_values(float quat[4], float eul[3], float axis[3], float *angle, short oldMode, short newMode);
125
126 /* B-Bone support */
127 typedef struct Mat4 {
128         float mat[4][4];
129 } Mat4;
130
131 Mat4 *b_bone_spline_setup(struct bPoseChannel *pchan, int rest);
132
133 /* like EBONE_VISIBLE */
134 #define PBONE_VISIBLE(arm, bone) (((bone)->layer & (arm)->layer) && !((bone)->flag & BONE_HIDDEN_P))
135
136 #ifdef __cplusplus
137 }
138 #endif
139
140 #endif
141