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