95d0c4cfaca42d6c5e2ab7692769680d65ce8a7f
[blender-staging.git] / source / blender / editors / include / ED_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  * Contributor(s): Blender Foundation
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27 #ifndef ED_ARMATURE_H
28 #define ED_ARMATURE_H
29
30 struct bArmature;
31 struct Base;
32 struct bContext;
33 struct Bone;
34 struct bPoseChannel;
35 struct DerivedMesh;
36 struct IDProperty;
37 struct ListBase;
38 struct MeshDeformModifierData;
39 struct Object;
40 struct RegionView3D;
41 struct Scene;
42 struct SK_Sketch;
43 struct View3D;
44 struct ViewContext;
45 struct wmKeyConfig;
46 struct wmOperator;
47
48 typedef struct EditBone
49 {
50         struct EditBone *next, *prev;
51         struct IDProperty               *prop;                  /* User-Defined Properties on this Bone */
52         struct EditBone *parent;/*      Editbones have a one-way link  (i.e. children refer
53                                                                         to parents.  This is converted to a two-way link for
54                                                                         normal bones when leaving editmode.     */
55         void    *temp;                  /*      Used to store temporary data */
56
57         char    name[32];
58         float   roll;                   /*      Roll along axis.  We'll ultimately use the axis/angle method
59                                                                 for determining the transformation matrix of the bone.  The axis
60                                                                 is tail-head while roll provides the angle. Refer to Graphics
61                                                                 Gems 1 p. 466 (section IX.6) if it's not already in here somewhere*/
62
63         float   head[3];                        /*      Orientation and length is implicit during editing */
64         float   tail[3];        
65                                                         /*      All joints are considered to have zero rotation with respect to
66                                                         their parents.  Therefore any rotations specified during the
67                                                         animation are automatically relative to the bones' rest positions*/
68         int             flag;
69         int             layer;
70         
71         float dist, weight;
72         float xwidth, length, zwidth;   /* put them in order! transform uses this as scale */
73         float ease1, ease2;
74         float rad_head, rad_tail;
75         
76         float oldlength;                                /* for envelope scaling */
77         
78         short segments;
79 } EditBone;
80
81 #define BONESEL_ROOT    0x10000000
82 #define BONESEL_TIP             0x20000000
83 #define BONESEL_BONE    0x40000000
84 #define BONESEL_ANY             (BONESEL_TIP|BONESEL_ROOT|BONESEL_BONE)
85
86 #define BONESEL_NOSEL   0x80000000      /* Indicates a negative number */
87
88 /* useful macros */
89 #define EBONE_VISIBLE(arm, ebone) ((arm->layer & ebone->layer) && !(ebone->flag & BONE_HIDDEN_A))
90 #define EBONE_EDITABLE(ebone) ((ebone->flag & BONE_SELECTED) && !(ebone->flag & BONE_EDITMODE_LOCKED)) 
91
92 /* used in bone_select_hierachy() */
93 #define BONE_SELECT_PARENT      0
94 #define BONE_SELECT_CHILD       1
95
96 /* armature_ops.c */
97 void ED_operatortypes_armature(void);
98 void ED_operatormacros_armature(void);
99 void ED_keymap_armature(struct wmKeyConfig *keyconf);
100
101 /* editarmature.c */
102 void ED_armature_from_edit(struct Object *obedit);
103 void ED_armature_to_edit(struct Object *ob);
104 void ED_armature_edit_free(struct Object *ob);
105 void ED_armature_edit_remake(struct Object *obedit);
106 void ED_armature_deselectall(struct Object *obedit, int toggle, int doundo);
107
108 int ED_do_pose_selectbuffer(struct Scene *scene, struct Base *base, unsigned int *buffer, 
109                                                         short hits, short extend);
110 int mouse_armature(struct bContext *C, short mval[2], int extend);
111 int join_armature_exec(struct bContext *C, struct wmOperator *op);
112 struct Bone *get_indexed_bone (struct Object *ob, int index);
113 float ED_rollBoneToVector(EditBone *bone, float new_up_axis[3]);
114 EditBone *ED_armature_bone_get_mirrored(struct ListBase *edbo, EditBone *ebo); // XXX this is needed for populating the context iterators
115 void ED_armature_sync_selection(struct ListBase *edbo);
116 void ED_armature_validate_active(struct bArmature *arm);
117
118 void add_primitive_bone(struct Scene *scene, struct View3D *v3d, struct RegionView3D *rv3d);
119 struct EditBone *ED_armature_edit_bone_add(struct bArmature *arm, char *name);
120 void ED_armature_edit_bone_remove(struct bArmature *arm, EditBone *exBone);
121
122 void transform_armature_mirror_update(struct Object *obedit);
123 void clear_armature(struct Scene *scene, struct Object *ob, char mode);
124 void docenter_armature (struct Scene *scene, struct View3D *v3d, struct Object *ob, int centermode);
125
126 void ED_armature_apply_transform(struct Object *ob, float mat[4][4]);
127
128 #define ARM_GROUPS_NAME         1
129 #define ARM_GROUPS_ENVELOPE     2
130 #define ARM_GROUPS_AUTO         3
131
132 void create_vgroups_from_armature(struct Scene *scene, struct Object *ob, struct Object *par, int mode, int mirror);
133
134 void auto_align_armature(struct Scene *scene, struct View3D *v3d, short mode);
135 void unique_editbone_name(struct ListBase *ebones, char *name, EditBone *bone); /* if bone is already in list, pass it as param to ignore it */
136 void ED_armature_bone_rename(struct bArmature *arm, char *oldnamep, char *newnamep);
137
138 void undo_push_armature(struct bContext *C, char *name);
139
140 /* poseobject.c */
141 void ED_armature_exit_posemode(struct bContext *C, struct Base *base);
142 void ED_armature_enter_posemode(struct bContext *C, struct Base *base);
143 int ED_pose_channel_in_IK_chain(struct Object *ob, struct bPoseChannel *pchan);
144 void ED_pose_deselectall(struct Object *ob, int test, int doundo);
145 void ED_pose_recalculate_paths(struct bContext *C, struct Scene *scene, struct Object *ob);
146
147 /* sketch */
148
149 int ED_operator_sketch_mode_active_stroke(struct bContext *C);
150 int ED_operator_sketch_full_mode(struct bContext *C);
151 int ED_operator_sketch_mode(const struct bContext *C);
152
153 void BIF_convertSketch(struct bContext *C);
154 void BIF_deleteSketch(struct bContext *C);
155 void BIF_selectAllSketch(struct bContext *C, int mode); /* -1: deselect, 0: select, 1: toggle */
156
157 void  BIF_makeListTemplates(const struct bContext *C);
158 char *BIF_listTemplates(const struct bContext *C);
159 int   BIF_currentTemplate(const struct bContext *C);
160 void  BIF_freeTemplates(struct bContext *C);
161 void  BIF_setTemplate(struct bContext *C, int index);
162 int   BIF_nbJointsTemplate(const struct bContext *C);
163 char * BIF_nameBoneTemplate(const struct bContext *C);
164
165 void BDR_drawSketch(const struct bContext *vc);
166 int BDR_drawSketchNames(struct ViewContext *vc);
167
168 /* meshlaplacian.c */
169 void mesh_deform_bind(struct Scene *scene, struct DerivedMesh *dm,
170         struct MeshDeformModifierData *mmd,
171         float *vertexcos, int totvert, float cagemat[][4]);
172
173 #endif /* ED_ARMATURE_H */
174
175
176