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