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