merged 30707:31141 from trunk
[blender.git] / source / blender / makesrna / intern / rna_armature.c
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  * Contributor(s): Blender Foundation (2008), Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28
29 #include "rna_internal.h"
30
31 #include "DNA_armature_types.h"
32 #include "DNA_object_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "WM_api.h"
36 #include "WM_types.h"
37
38 #ifdef RNA_RUNTIME
39
40 #include "BLI_math.h"
41
42 #include "BKE_context.h"
43 #include "BKE_depsgraph.h"
44 #include "BKE_idprop.h"
45 #include "BKE_main.h"
46
47 #include "ED_armature.h"
48 #include "BKE_armature.h"
49
50 static void rna_Armature_update_data(Main *bmain, Scene *scene, PointerRNA *ptr)
51 {
52         ID *id= ptr->id.data;
53
54         DAG_id_flush_update(id, OB_RECALC_DATA);
55         WM_main_add_notifier(NC_GEOM|ND_DATA, id);
56         //WM_main_add_notifier(NC_OBJECT|ND_POSE, NULL);
57 }
58
59
60 static void rna_Armature_act_bone_set(PointerRNA *ptr, PointerRNA value)
61 {
62         bArmature *arm= (bArmature*)ptr->data;
63
64         if(value.id.data==NULL && value.data==NULL) {
65                 arm->act_bone= NULL;
66         }
67         else {
68                 if(value.id.data != arm) {
69                         /* raise an error! */
70                 }
71                 else {
72                         arm->act_bone= value.data;
73                         arm->act_bone->flag |= BONE_SELECTED;
74                 }
75         }
76 }
77
78 static void rna_Armature_act_edit_bone_set(PointerRNA *ptr, PointerRNA value)
79 {
80         bArmature *arm= (bArmature*)ptr->data;
81
82         if(value.id.data==NULL && value.data==NULL) {
83                 arm->act_edbone= NULL;
84         }
85         else {
86                 if(value.id.data != arm) {
87                         /* raise an error! */
88                 }
89                 else {
90                         arm->act_edbone= value.data;
91                         ((EditBone *)arm->act_edbone)->flag |= BONE_SELECTED;
92                 }
93         }
94 }
95
96 EditBone *rna_Armature_edit_bone_new(bArmature *arm, ReportList *reports, char *name)
97 {
98         if(arm->edbo==NULL) {
99                 BKE_reportf(reports, RPT_ERROR, "Armature '%s' not in editmode, cant add an editbone.", arm->id.name+2);
100                 return NULL;
101         }
102         return ED_armature_edit_bone_add(arm, name);
103 }
104
105 void rna_Armature_edit_bone_remove(bArmature *arm, ReportList *reports, EditBone *ebone)
106 {
107         if(arm->edbo==NULL) {
108                 BKE_reportf(reports, RPT_ERROR, "Armature '%s' not in editmode, cant remove an editbone.", arm->id.name+2);
109                 return;
110         }
111         ED_armature_edit_bone_remove(arm, ebone);
112 }
113
114 static void rna_Armature_redraw_data(Main *bmain, Scene *scene, PointerRNA *ptr)
115 {
116         ID *id= ptr->id.data;
117
118         WM_main_add_notifier(NC_GEOM|ND_DATA, id);
119 }
120
121 static char *rna_Bone_path(PointerRNA *ptr)
122 {
123         return BLI_sprintfN("bones[\"%s\"]", ((Bone*)ptr->data)->name);
124 }
125
126 static IDProperty *rna_Bone_idproperties(PointerRNA *ptr, int create)
127 {
128         Bone *bone= ptr->data;
129
130         if(create && !bone->prop) {
131                 IDPropertyTemplate val = {0};
132                 bone->prop= IDP_New(IDP_GROUP, val, "RNA_Bone ID properties");
133         }
134
135         return bone->prop;
136 }
137
138 static IDProperty *rna_EditBone_idproperties(PointerRNA *ptr, int create)
139 {
140         EditBone *ebone= ptr->data;
141
142         if(create && !ebone->prop) {
143                 IDPropertyTemplate val = {0};
144                 ebone->prop= IDP_New(IDP_GROUP, val, "RNA_EditBone ID properties");
145         }
146
147         return ebone->prop;
148 }
149
150 static void rna_bone_layer_set(int *layer, const int *values)
151 {
152         int i, tot= 0;
153
154         /* ensure we always have some layer selected */
155         for(i=0; i<32; i++)
156                 if(values[i])
157                         tot++;
158         
159         if(tot==0)
160                 return;
161
162         for(i=0; i<32; i++) {
163                 if(values[i]) *layer |= (1<<i);
164                 else *layer &= ~(1<<i);
165         }
166 }
167
168 static void rna_Bone_layer_set(PointerRNA *ptr, const int *values)
169 {
170         Bone *bone= (Bone*)ptr->data;
171         rna_bone_layer_set(&bone->layer, values);
172 }
173
174 static void rna_Armature_layer_set(PointerRNA *ptr, const int *values)
175 {
176         bArmature *arm= (bArmature*)ptr->data;
177         int i, tot= 0;
178
179         /* ensure we always have some layer selected */
180         for(i=0; i<32; i++)
181                 if(values[i])
182                         tot++;
183         
184         if(tot==0)
185                 return;
186
187         for(i=0; i<32; i++) {
188                 if(values[i]) arm->layer |= (1<<i);
189                 else arm->layer &= ~(1<<i);
190         }
191 }
192
193 // XXX depreceated.... old armature only animviz
194 static void rna_Armature_ghost_start_frame_set(PointerRNA *ptr, int value)
195 {
196         bArmature *data= (bArmature*)ptr->data;
197         CLAMP(value, 1, data->ghostef);
198         data->ghostsf= value;
199 }
200
201 static void rna_Armature_ghost_end_frame_set(PointerRNA *ptr, int value)
202 {
203         bArmature *data= (bArmature*)ptr->data;
204         CLAMP(value, data->ghostsf, (int)(MAXFRAMEF/2));
205         data->ghostef= value;
206 }
207 // XXX depreceated... old armature only animviz
208
209 static void rna_EditBone_name_set(PointerRNA *ptr, const char *value)
210 {
211         bArmature *arm= (bArmature*)ptr->id.data;
212         EditBone *ebone= (EditBone*)ptr->data;
213         char oldname[sizeof(ebone->name)], newname[sizeof(ebone->name)];
214         
215         /* need to be on the stack */
216         BLI_strncpy(newname, value, sizeof(ebone->name));
217         BLI_strncpy(oldname, ebone->name, sizeof(ebone->name));
218         
219         ED_armature_bone_rename(arm, oldname, newname);
220 }
221
222 static void rna_Bone_name_set(PointerRNA *ptr, const char *value)
223 {
224         bArmature *arm= (bArmature*)ptr->id.data;
225         Bone *bone= (Bone*)ptr->data;
226         char oldname[sizeof(bone->name)], newname[sizeof(bone->name)];
227         
228         /* need to be on the stack */
229         BLI_strncpy(newname, value, sizeof(bone->name));
230         BLI_strncpy(oldname, bone->name, sizeof(bone->name));
231
232         ED_armature_bone_rename(arm, oldname, newname);
233 }
234
235 static void rna_EditBone_layer_set(PointerRNA *ptr, const int values[])
236 {
237         EditBone *data= (EditBone*)(ptr->data);
238         rna_bone_layer_set(&data->layer, values);
239 }
240
241 static void rna_EditBone_connected_check(EditBone *ebone)
242 {
243         if(ebone->parent) {
244                 if(ebone->flag & BONE_CONNECTED) {
245                         /* Attach this bone to its parent */
246                         VECCOPY(ebone->head, ebone->parent->tail);
247
248                         if(ebone->flag & BONE_ROOTSEL)
249                                 ebone->parent->flag |= BONE_TIPSEL;
250                 }
251                 else if(!(ebone->parent->flag & BONE_ROOTSEL)) {
252                         ebone->parent->flag &= ~BONE_TIPSEL;
253                 }
254         }
255 }
256
257 static void rna_EditBone_connected_set(PointerRNA *ptr, int value)
258 {
259         EditBone *ebone= (EditBone*)(ptr->data);
260
261         if(value) ebone->flag |= BONE_CONNECTED;
262         else ebone->flag &= ~BONE_CONNECTED;
263
264         rna_EditBone_connected_check(ebone);
265 }
266
267 static PointerRNA rna_EditBone_parent_get(PointerRNA *ptr)
268 {
269         EditBone *data= (EditBone*)(ptr->data);
270         return rna_pointer_inherit_refine(ptr, &RNA_EditBone, data->parent);
271 }
272
273 static void rna_EditBone_parent_set(PointerRNA *ptr, PointerRNA value)
274 {
275         EditBone *ebone= (EditBone*)(ptr->data);
276         EditBone *pbone, *parbone= (EditBone*)value.data;
277
278         if(parbone == NULL) {
279                 if(ebone->parent && !(ebone->parent->flag & BONE_ROOTSEL))
280                         ebone->parent->flag &= ~BONE_TIPSEL;
281
282                 ebone->parent = NULL;
283                 ebone->flag &= ~BONE_CONNECTED;
284         }
285         else {
286                 /* within same armature */
287                 if(value.id.data != ptr->id.data)
288                         return;
289
290                 /* make sure this is a valid child */
291                 if(parbone == ebone)
292                         return;
293                         
294                 for(pbone= parbone->parent; pbone; pbone=pbone->parent)
295                         if(pbone == ebone)
296                                 return;
297
298                 ebone->parent = parbone;
299                 rna_EditBone_connected_check(ebone);
300         }
301 }
302
303 static void rna_EditBone_matrix_get(PointerRNA *ptr, float *values)
304 {
305         EditBone *ebone= (EditBone*)(ptr->data);
306
307         float   delta[3], tmat[3][3], mat[4][4];
308
309         /* Find the current bone matrix */
310         sub_v3_v3v3(delta, ebone->tail, ebone->head);
311         vec_roll_to_mat3(delta, ebone->roll, tmat);
312         copy_m4_m3(mat, tmat);
313         VECCOPY(mat[3], ebone->head);
314
315         memcpy(values, mat, 16 * sizeof(float));
316 }
317
318 static void rna_Armature_editbone_transform_update(Main *bmain, Scene *scene, PointerRNA *ptr)
319 {
320         bArmature *arm= (bArmature*)ptr->id.data;
321         EditBone *ebone= (EditBone*)ptr->data;
322         EditBone *child, *eboflip;
323         
324         /* update our parent */
325         if(ebone->parent && ebone->flag & BONE_CONNECTED)
326                 VECCOPY(ebone->parent->tail, ebone->head)
327
328         /* update our children if necessary */
329         for(child = arm->edbo->first; child; child=child->next)
330                 if(child->parent == ebone && (child->flag & BONE_CONNECTED))
331                         VECCOPY(child->head, ebone->tail);
332
333         if(arm->flag & ARM_MIRROR_EDIT) {
334                 eboflip= ED_armature_bone_get_mirrored(arm->edbo, ebone);
335
336                 if(eboflip) {
337                         eboflip->roll= -ebone->roll;
338
339                         eboflip->head[0]= -ebone->head[0];
340                         eboflip->tail[0]= -ebone->tail[0];
341                         
342                         /* update our parent */
343                         if(eboflip->parent && eboflip->flag & BONE_CONNECTED)
344                                 VECCOPY(eboflip->parent->tail, eboflip->head);
345                         
346                         /* update our children if necessary */
347                         for(child = arm->edbo->first; child; child=child->next)
348                                 if(child->parent == eboflip && (child->flag & BONE_CONNECTED))
349                                         VECCOPY (child->head, eboflip->tail);
350                 }
351         }
352
353         rna_Armature_update_data(bmain, scene, ptr);
354 }
355
356 static void rna_Armature_bones_next(CollectionPropertyIterator *iter)
357 {
358         ListBaseIterator *internal= iter->internal;
359         Bone *bone= (Bone*)internal->link;
360
361         if(bone->childbase.first)
362                 internal->link= (Link*)bone->childbase.first;
363         else if(bone->next)
364                 internal->link= (Link*)bone->next;
365         else {
366                 internal->link= NULL;
367
368                 do {
369                         bone= bone->parent;
370                         if(bone && bone->next) {
371                                 internal->link= (Link*)bone->next;
372                                 break;
373                         }
374                 } while(bone);
375         }
376
377         iter->valid= (internal->link != NULL);
378 }
379
380 #else
381
382 static void rna_def_bone_common(StructRNA *srna, int editbone)
383 {
384         PropertyRNA *prop;
385
386         /* strings */
387         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
388         RNA_def_property_string_sdna(prop, NULL, "name");
389         RNA_def_property_ui_text(prop, "Name", "");
390         RNA_def_struct_name_property(srna, prop);
391         if(editbone) RNA_def_property_string_funcs(prop, NULL, NULL, "rna_EditBone_name_set");
392         else RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Bone_name_set");
393         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
394
395         /* flags */
396         prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_LAYER_MEMBER);
397         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
398         RNA_def_property_array(prop, 32);
399         if(editbone) RNA_def_property_boolean_funcs(prop, NULL, "rna_EditBone_layer_set");
400         else RNA_def_property_boolean_funcs(prop, NULL, "rna_Bone_layer_set");
401         RNA_def_property_ui_text(prop, "Layers", "Layers bone exists in");
402         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
403
404         prop= RNA_def_property(srna, "connected", PROP_BOOLEAN, PROP_NONE);
405         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_CONNECTED);
406         if(editbone) RNA_def_property_boolean_funcs(prop, NULL, "rna_EditBone_connected_set");
407         else RNA_def_property_clear_flag(prop, PROP_EDITABLE);
408         RNA_def_property_ui_text(prop, "Connected", "When bone has a parent, bone's head is struck to the parent's tail");
409         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
410         
411         prop= RNA_def_property(srna, "hinge", PROP_BOOLEAN, PROP_NONE);
412         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_HINGE);
413         RNA_def_property_ui_text(prop, "Inherit Rotation", "Bone inherits rotation or scale from parent bone");
414         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
415         
416         prop= RNA_def_property(srna, "multiply_vertexgroup_with_envelope", PROP_BOOLEAN, PROP_NONE);
417         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_MULT_VG_ENV);
418         RNA_def_property_ui_text(prop, "Multiply Vertex Group with Envelope", "When deforming bone, multiply effects of Vertex Group weights with Envelope influence");
419         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
420         
421         prop= RNA_def_property(srna, "deform", PROP_BOOLEAN, PROP_NONE);
422         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_DEFORM);
423         RNA_def_property_ui_text(prop, "Deform", "Bone does not deform any geometry");
424         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
425         
426         prop= RNA_def_property(srna, "inherit_scale", PROP_BOOLEAN, PROP_NONE);
427         RNA_def_property_ui_text(prop, "Inherit Scale", "Bone inherits scaling from parent bone");
428         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_SCALE);
429         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
430
431         prop= RNA_def_property(srna, "local_location", PROP_BOOLEAN, PROP_NONE);
432         RNA_def_property_ui_text(prop, "Local Location", "Bone location is set in local space");
433         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_LOCAL_LOCATION);
434         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
435         
436         prop= RNA_def_property(srna, "draw_wire", PROP_BOOLEAN, PROP_NONE);
437         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_DRAWWIRE);
438         RNA_def_property_ui_text(prop, "Draw Wire", "Bone is always drawn as Wireframe regardless of viewport draw mode. Useful for non-obstructive custom bone shapes");
439         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
440         
441         prop= RNA_def_property(srna, "cyclic_offset", PROP_BOOLEAN, PROP_NONE);
442         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_CYCLICOFFSET);
443         RNA_def_property_ui_text(prop, "Cyclic Offset", "When bone doesn't have a parent, it receives cyclic offset effects");
444         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
445         
446         prop= RNA_def_property(srna, "hide_select", PROP_BOOLEAN, PROP_NONE);
447         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_UNSELECTABLE);
448         RNA_def_property_ui_text(prop, "Selectable", "Bone is able to be selected");
449         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
450
451         /* Number values */
452                 /* envelope deform settings */
453         prop= RNA_def_property(srna, "envelope_distance", PROP_FLOAT, PROP_NONE);
454         RNA_def_property_float_sdna(prop, NULL, "dist");
455         RNA_def_property_range(prop, 0.0f, 1000.0f);
456         RNA_def_property_ui_text(prop, "Envelope Deform Distance", "Bone deformation distance (for Envelope deform only)");
457         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
458         
459         prop= RNA_def_property(srna, "envelope_weight", PROP_FLOAT, PROP_NONE);
460         RNA_def_property_float_sdna(prop, NULL, "weight");
461         RNA_def_property_range(prop, 0.0f, 1000.0f);
462         RNA_def_property_ui_text(prop, "Envelope Deform Weight", "Bone deformation weight (for Envelope deform only)");
463         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
464         
465         prop= RNA_def_property(srna, "head_radius", PROP_FLOAT, PROP_NONE);
466         if(editbone) RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
467         RNA_def_property_float_sdna(prop, NULL, "rad_head");
468         //RNA_def_property_range(prop, 0, 1000);  // XXX range is 0 to lim, where lim= 10000.0f*MAX2(1.0, view3d->grid);
469         RNA_def_property_ui_text(prop, "Envelope Head Radius", "Radius of head of bone (for Envelope deform only)");
470         
471         prop= RNA_def_property(srna, "tail_radius", PROP_FLOAT, PROP_NONE);
472         if(editbone) RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
473         RNA_def_property_float_sdna(prop, NULL, "rad_tail");
474         //RNA_def_property_range(prop, 0, 1000);  // XXX range is 0 to lim, where lim= 10000.0f*MAX2(1.0, view3d->grid);
475         RNA_def_property_ui_text(prop, "Envelope Tail Radius", "Radius of tail of bone (for Envelope deform only)");
476         
477                 /* b-bones deform settings */
478         prop= RNA_def_property(srna, "bbone_segments", PROP_INT, PROP_NONE);
479         RNA_def_property_int_sdna(prop, NULL, "segments");
480         RNA_def_property_range(prop, 1, 32);
481         RNA_def_property_ui_text(prop, "B-Bone Segments", "Number of subdivisions of bone (for B-Bones only)");
482         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
483         
484         prop= RNA_def_property(srna, "bbone_in", PROP_FLOAT, PROP_NONE);
485         RNA_def_property_float_sdna(prop, NULL, "ease1");
486         RNA_def_property_range(prop, 0.0f, 2.0f);
487         RNA_def_property_ui_text(prop, "B-Bone Ease In", "Length of first Bezier Handle (for B-Bones only)");
488         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
489         
490         prop= RNA_def_property(srna, "bbone_out", PROP_FLOAT, PROP_NONE);
491         RNA_def_property_float_sdna(prop, NULL, "ease2");
492         RNA_def_property_range(prop, 0.0f, 2.0f);
493         RNA_def_property_ui_text(prop, "B-Bone Ease Out", "Length of second Bezier Handle (for B-Bones only)");
494         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
495 }
496
497 // err... bones should not be directly edited (only editbones should be...)
498 static void rna_def_bone(BlenderRNA *brna)
499 {
500         StructRNA *srna;
501         PropertyRNA *prop;
502         
503         srna= RNA_def_struct(brna, "Bone", NULL);
504         RNA_def_struct_ui_text(srna, "Bone", "Bone in an Armature datablock");
505         RNA_def_struct_ui_icon(srna, ICON_BONE_DATA);
506         RNA_def_struct_path_func(srna, "rna_Bone_path");
507         RNA_def_struct_idproperties_func(srna, "rna_Bone_idproperties");
508         
509         /* pointers/collections */
510                 /* parent (pointer) */
511         prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
512         RNA_def_property_struct_type(prop, "Bone");
513         RNA_def_property_pointer_sdna(prop, NULL, "parent");
514         RNA_def_property_ui_text(prop, "Parent", "Parent bone (in same Armature)");
515         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
516         
517                 /* children (collection) */
518         prop= RNA_def_property(srna, "children", PROP_COLLECTION, PROP_NONE);
519         RNA_def_property_collection_sdna(prop, NULL, "childbase", NULL);
520         RNA_def_property_struct_type(prop, "Bone");
521         RNA_def_property_ui_text(prop, "Children", "Bones which are children of this bone");
522
523         rna_def_bone_common(srna, 0);
524
525                 // XXX should we define this in PoseChannel wrapping code instead? but PoseChannels directly get some of their flags from here...
526         prop= RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
527         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_HIDDEN_P);
528         RNA_def_property_ui_text(prop, "Hide", "Bone is not visible when it is not in Edit Mode (i.e. in Object or Pose Modes)");
529         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
530
531         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
532         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_SELECTED);
533         RNA_def_property_ui_text(prop, "Select", "");
534         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
535
536         /* XXX better matrix descriptions possible (Arystan) */
537         prop= RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
538         RNA_def_property_float_sdna(prop, NULL, "bone_mat");
539         RNA_def_property_array(prop, 9);
540         RNA_def_property_ui_text(prop, "Bone Matrix", "3x3 bone matrix");
541
542         prop= RNA_def_property(srna, "matrix_local", PROP_FLOAT, PROP_MATRIX);
543         RNA_def_property_float_sdna(prop, NULL, "arm_mat");
544         RNA_def_property_array(prop, 16);
545         RNA_def_property_ui_text(prop, "Bone Armature-Relative Matrix", "4x4 bone matrix relative to armature");
546
547         prop= RNA_def_property(srna, "tail", PROP_FLOAT, PROP_TRANSLATION);
548         RNA_def_property_float_sdna(prop, NULL, "tail");
549         RNA_def_property_array(prop, 3);
550         RNA_def_property_ui_text(prop, "Tail", "Location of tail end of the bone");
551
552         prop= RNA_def_property(srna, "tail_local", PROP_FLOAT, PROP_TRANSLATION);
553         RNA_def_property_float_sdna(prop, NULL, "arm_tail");
554         RNA_def_property_array(prop, 3);
555         RNA_def_property_ui_text(prop, "Armature-Relative Tail", "Location of tail end of the bone relative to armature");
556
557         prop= RNA_def_property(srna, "head", PROP_FLOAT, PROP_TRANSLATION);
558         RNA_def_property_float_sdna(prop, NULL, "head");
559         RNA_def_property_array(prop, 3);
560         RNA_def_property_ui_text(prop, "Head", "Location of head end of the bone relative to its parent");
561
562         prop= RNA_def_property(srna, "head_local", PROP_FLOAT, PROP_TRANSLATION);
563         RNA_def_property_float_sdna(prop, NULL, "arm_head");
564         RNA_def_property_array(prop, 3);
565         RNA_def_property_ui_text(prop, "Armature-Relative Head", "Location of head end of the bone relative to armature");
566 }
567
568 static void rna_def_edit_bone(BlenderRNA *brna)
569 {
570         StructRNA *srna;
571         PropertyRNA *prop;
572         
573         srna= RNA_def_struct(brna, "EditBone", NULL);
574         RNA_def_struct_sdna(srna, "EditBone");
575         RNA_def_struct_idproperties_func(srna, "rna_EditBone_idproperties");
576         RNA_def_struct_ui_text(srna, "Edit Bone", "Editmode bone in an Armature datablock");
577         RNA_def_struct_ui_icon(srna, ICON_BONE_DATA);
578         
579         RNA_define_verify_sdna(0); // not in sdna
580
581         prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
582         RNA_def_property_struct_type(prop, "EditBone");
583         RNA_def_property_pointer_funcs(prop, "rna_EditBone_parent_get", "rna_EditBone_parent_set", NULL, NULL);
584         RNA_def_property_flag(prop, PROP_EDITABLE);
585         RNA_def_property_ui_text(prop, "Parent", "Parent edit bone (in same Armature)");
586         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
587         
588         prop= RNA_def_property(srna, "roll", PROP_FLOAT, PROP_NONE);
589         RNA_def_property_float_sdna(prop, NULL, "roll");
590         RNA_def_property_ui_text(prop, "Roll", "Bone rotation around head-tail axis");
591         RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
592
593         prop= RNA_def_property(srna, "head", PROP_FLOAT, PROP_TRANSLATION);
594         RNA_def_property_float_sdna(prop, NULL, "head");
595         RNA_def_property_array(prop, 3);
596         RNA_def_property_ui_text(prop, "Head", "Location of head end of the bone");
597         RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
598
599         prop= RNA_def_property(srna, "tail", PROP_FLOAT, PROP_TRANSLATION);
600         RNA_def_property_float_sdna(prop, NULL, "tail");
601         RNA_def_property_array(prop, 3);
602         RNA_def_property_ui_text(prop, "Tail", "Location of tail end of the bone");
603         RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
604
605         rna_def_bone_common(srna, 1);
606
607         prop= RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
608         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_HIDDEN_A);
609         RNA_def_property_ui_text(prop, "Hide", "Bone is not visible when in Edit Mode");
610         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
611
612         prop= RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
613         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_EDITMODE_LOCKED);
614         RNA_def_property_ui_text(prop, "Lock", "Bone is not able to be transformed when in Edit Mode");
615         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
616
617         prop= RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
618         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_SELECTED);
619         RNA_def_property_ui_text(prop, "Select", "");
620         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
621
622         prop= RNA_def_property(srna, "select_head", PROP_BOOLEAN, PROP_NONE);
623         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_ROOTSEL);
624         RNA_def_property_ui_text(prop, "Head Select", "");
625         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
626         
627         prop= RNA_def_property(srna, "select_tail", PROP_BOOLEAN, PROP_NONE);
628         RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_TIPSEL);
629         RNA_def_property_ui_text(prop, "Tail Select", "");
630         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
631
632         /* calculated and read only, not actual data access */
633         prop= RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
634         //RNA_def_property_float_sdna(prop, NULL, ""); // doesnt access any real data
635         RNA_def_property_array(prop, 16);
636         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
637         RNA_def_property_flag(prop, PROP_THICK_WRAP); /* no reference to original data */
638         RNA_def_property_ui_text(prop, "Editbone Matrix", "Read-only matrix calculated from the roll (armature space)");
639         RNA_def_property_float_funcs(prop, "rna_EditBone_matrix_get", NULL, NULL); // TODO - this could be made writable also
640
641         RNA_api_armature_edit_bone(srna);
642
643         RNA_define_verify_sdna(1);
644 }
645
646
647 /* armature.bones.* */
648 static void rna_def_armature_bones(BlenderRNA *brna, PropertyRNA *cprop)
649 {
650         StructRNA *srna;
651         PropertyRNA *prop;
652
653 //      FunctionRNA *func;
654 //      PropertyRNA *parm;
655
656         RNA_def_property_srna(cprop, "ArmatureBones");
657         srna= RNA_def_struct(brna, "ArmatureBones", NULL);
658         RNA_def_struct_sdna(srna, "bArmature");
659         RNA_def_struct_ui_text(srna, "Armature Bones", "Collection of armature bones");
660
661
662         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
663         RNA_def_property_struct_type(prop, "Bone");
664         RNA_def_property_pointer_sdna(prop, NULL, "act_bone");
665         RNA_def_property_flag(prop, PROP_EDITABLE);
666         RNA_def_property_ui_text(prop, "Active Bone", "Armatures active bone");
667         RNA_def_property_pointer_funcs(prop, NULL, "rna_Armature_act_bone_set", NULL, NULL);
668
669         /* todo, redraw */
670 //              RNA_def_property_collection_active(prop, prop_act);
671 }
672
673 /* armature.bones.* */
674 static void rna_def_armature_edit_bones(BlenderRNA *brna, PropertyRNA *cprop)
675 {
676         StructRNA *srna;
677         PropertyRNA *prop;
678
679         FunctionRNA *func;
680         PropertyRNA *parm;
681
682         RNA_def_property_srna(cprop, "ArmatureEditBones");
683         srna= RNA_def_struct(brna, "ArmatureEditBones", NULL);
684         RNA_def_struct_sdna(srna, "bArmature");
685         RNA_def_struct_ui_text(srna, "Armature EditBones", "Collection of armature edit bones");
686
687         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
688         RNA_def_property_struct_type(prop, "EditBone");
689         RNA_def_property_pointer_sdna(prop, NULL, "act_edbone");
690         RNA_def_property_flag(prop, PROP_EDITABLE);
691         RNA_def_property_ui_text(prop, "Active EditBone", "Armatures active edit bone");
692         //RNA_def_property_update(prop, 0, "rna_Armature_act_editbone_update");
693         RNA_def_property_pointer_funcs(prop, NULL, "rna_Armature_act_edit_bone_set", NULL, NULL);
694
695         /* todo, redraw */
696 //              RNA_def_property_collection_active(prop, prop_act);
697
698         /* add target */
699         func= RNA_def_function(srna, "new", "rna_Armature_edit_bone_new");
700         RNA_def_function_flag(func, FUNC_USE_REPORTS);
701         RNA_def_function_ui_description(func, "Add a new bone.");
702         parm= RNA_def_string(func, "name", "Object", 0, "", "New name for the bone");
703         RNA_def_property_flag(parm, PROP_REQUIRED);
704
705         /* return type */
706         parm= RNA_def_pointer(func, "bone", "EditBone", "", "Newly created edit bone");
707         RNA_def_function_return(func, parm);
708
709         /* remove target */
710         func= RNA_def_function(srna, "remove", "rna_Armature_edit_bone_remove");
711         RNA_def_function_flag(func, FUNC_USE_REPORTS);
712         RNA_def_function_ui_description(func, "Remove an existing bone from the armature");
713         /* target to remove*/
714         parm= RNA_def_pointer(func, "bone", "EditBone", "", "EditBone to remove");
715         RNA_def_property_flag(parm, PROP_REQUIRED);
716 }
717
718 static void rna_def_armature(BlenderRNA *brna)
719 {
720         StructRNA *srna;
721         PropertyRNA *prop;
722         
723         static EnumPropertyItem prop_drawtype_items[] = {
724                 {ARM_OCTA, "OCTAHEDRAL", 0, "Octahedral", "Display bones as octahedral shape (default)"},
725                 {ARM_LINE, "STICK", 0, "Stick", "Display bones as simple 2D lines with dots"},
726                 {ARM_B_BONE, "BBONE", 0, "B-Bone", "Display bones as boxes, showing subdivision and B-Splines"},
727                 {ARM_ENVELOPE, "ENVELOPE", 0, "Envelope", "Display bones as extruded spheres, showing defomation influence volume"},
728                 {0, NULL, 0, NULL, NULL}};
729         static EnumPropertyItem prop_ghost_type_items[] = {
730                 {ARM_GHOST_CUR, "CURRENT_FRAME", 0, "Around Frame", "Display Ghosts of poses within a fixed number of frames around the current frame"},
731                 {ARM_GHOST_RANGE, "RANGE", 0, "In Range", "Display Ghosts of poses within specified range"},
732                 {ARM_GHOST_KEYS, "KEYS", 0, "On Keyframes", "Display Ghosts of poses on Keyframes"},
733                 {0, NULL, 0, NULL, NULL}};
734         static const EnumPropertyItem prop_pose_position_items[]= {
735                 {0, "POSE", 0, "Pose Position", "Show armature in posed state"},
736                 {ARM_RESTPOS, "REST", 0, "Rest Position", "Show Armature in binding pose state. No posing possible"},
737                 {0, NULL, 0, NULL, NULL}};
738         
739         srna= RNA_def_struct(brna, "Armature", "ID");
740         RNA_def_struct_ui_text(srna, "Armature", "Armature datablock containing a hierarchy of bones, usually used for rigging characters");
741         RNA_def_struct_ui_icon(srna, ICON_ARMATURE_DATA);
742         RNA_def_struct_sdna(srna, "bArmature");
743         
744         /* Animation Data */
745         rna_def_animdata_common(srna);
746         
747         /* Collections */
748         prop= RNA_def_property(srna, "bones", PROP_COLLECTION, PROP_NONE);
749         RNA_def_property_collection_sdna(prop, NULL, "bonebase", NULL);
750         RNA_def_property_collection_funcs(prop, 0, "rna_Armature_bones_next", 0, 0, 0, 0, 0);
751         RNA_def_property_struct_type(prop, "Bone");
752         RNA_def_property_ui_text(prop, "Bones", "");
753         rna_def_armature_bones(brna, prop);
754
755         prop= RNA_def_property(srna, "edit_bones", PROP_COLLECTION, PROP_NONE);
756         RNA_def_property_collection_sdna(prop, NULL, "edbo", NULL);
757         RNA_def_property_struct_type(prop, "EditBone");
758         RNA_def_property_ui_text(prop, "Edit Bones", "");
759         rna_def_armature_edit_bones(brna, prop);
760
761         /* Enum values */
762         prop= RNA_def_property(srna, "pose_position", PROP_ENUM, PROP_NONE);
763         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
764         RNA_def_property_enum_items(prop, prop_pose_position_items);
765         RNA_def_property_ui_text(prop, "Pose Position", "Show armature in binding pose or final posed state");
766         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
767         
768         prop= RNA_def_property(srna, "drawtype", PROP_ENUM, PROP_NONE);
769         RNA_def_property_enum_items(prop, prop_drawtype_items);
770         RNA_def_property_ui_text(prop, "Draw Type", "");
771         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
772         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
773         
774 // XXX depreceated ....... old animviz for armatures only
775         prop= RNA_def_property(srna, "ghost_type", PROP_ENUM, PROP_NONE);
776         RNA_def_property_enum_sdna(prop, NULL, "ghosttype");
777         RNA_def_property_enum_items(prop, prop_ghost_type_items);
778         RNA_def_property_ui_text(prop, "Ghost Type", "Method of Onion-skinning for active Action");
779         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
780         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
781 // XXX depreceated ....... old animviz for armatures only       
782
783         /* Boolean values */
784                 /* layer */
785         prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_LAYER_MEMBER);
786         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
787         RNA_def_property_array(prop, 32);
788         RNA_def_property_ui_text(prop, "Visible Layers", "Armature layer visibility");
789         RNA_def_property_boolean_funcs(prop, NULL, "rna_Armature_layer_set");
790         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Armature_redraw_data");
791         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
792         
793                 /* layer protection */
794         prop= RNA_def_property(srna, "layer_protection", PROP_BOOLEAN, PROP_LAYER);
795         RNA_def_property_boolean_sdna(prop, NULL, "layer_protected", 1);
796         RNA_def_property_array(prop, 32);
797         RNA_def_property_ui_text(prop, "Layer Proxy Protection", "Protected layers in Proxy Instances are restored to Proxy settings on file reload and undo"); 
798         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
799                 
800                 /* flag */
801         prop= RNA_def_property(srna, "draw_axes", PROP_BOOLEAN, PROP_NONE);
802         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWAXES);
803         RNA_def_property_ui_text(prop, "Draw Axes", "Draw bone axes");
804         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
805         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
806         
807         prop= RNA_def_property(srna, "draw_names", PROP_BOOLEAN, PROP_NONE);
808         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWNAMES);
809         RNA_def_property_ui_text(prop, "Draw Names", "Draw bone names");
810         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
811         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
812         
813         prop= RNA_def_property(srna, "delay_deform", PROP_BOOLEAN, PROP_NONE);
814         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DELAYDEFORM);
815         RNA_def_property_ui_text(prop, "Delay Deform", "Don't deform children when manipulating bones in Pose Mode");
816         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
817         
818         prop= RNA_def_property(srna, "x_axis_mirror", PROP_BOOLEAN, PROP_NONE);
819         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_MIRROR_EDIT);
820         RNA_def_property_ui_text(prop, "X-Axis Mirror", "Apply changes to matching bone on opposite side of X-Axis");
821         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
822         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
823         
824         prop= RNA_def_property(srna, "auto_ik", PROP_BOOLEAN, PROP_NONE);
825         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_AUTO_IK);
826         RNA_def_property_ui_text(prop, "Auto IK", "Add temporaral IK constraints while grabbing bones in Pose Mode");
827         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
828         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
829         
830         prop= RNA_def_property(srna, "draw_custom_bone_shapes", PROP_BOOLEAN, PROP_NONE);
831         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ARM_NO_CUSTOM);
832         RNA_def_property_ui_text(prop, "Draw Custom Bone Shapes", "Draw bones with their custom shapes");
833         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
834         
835         prop= RNA_def_property(srna, "draw_group_colors", PROP_BOOLEAN, PROP_NONE);
836         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_COL_CUSTOM);
837         RNA_def_property_ui_text(prop, "Draw Bone Group Colors", "Draw bone group colors");
838         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
839         
840 // XXX depreceated ....... old animviz for armatures only
841         prop= RNA_def_property(srna, "ghost_only_selected", PROP_BOOLEAN, PROP_NONE);
842         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_GHOST_ONLYSEL);
843         RNA_def_property_ui_text(prop, "Draw Ghosts on Selected Bones Only", "");
844         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
845         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
846 // XXX depreceated ....... old animviz for armatures only
847         
848                 /* deformflag */
849         prop= RNA_def_property(srna, "deform_vertexgroups", PROP_BOOLEAN, PROP_NONE);
850         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_VGROUP);
851         RNA_def_property_ui_text(prop, "Deform Vertex Groups", "Enable Vertex Groups when defining deform");
852         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
853         
854         prop= RNA_def_property(srna, "deform_envelope", PROP_BOOLEAN, PROP_NONE);
855         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_ENVELOPE);
856         RNA_def_property_ui_text(prop, "Deform Envelopes", "Enable Bone Envelopes when defining deform");
857         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
858         
859         prop= RNA_def_property(srna, "deform_quaternion", PROP_BOOLEAN, PROP_NONE);
860         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_QUATERNION);
861         RNA_def_property_ui_text(prop, "Use Dual Quaternion Deformation", "Enable deform rotation with Quaternions");
862         RNA_def_property_update(prop, 0, "rna_Armature_update_data");
863         
864         //prop= RNA_def_property(srna, "deform_invert_vertexgroups", PROP_BOOLEAN, PROP_NONE);
865         //RNA_def_property_boolean_negative_sdna(prop, NULL, "deformflag", ARM_DEF_INVERT_VGROUP);
866         //RNA_def_property_ui_text(prop, "Invert Vertex Group Influence", "Invert Vertex Group influence (only for Modifiers)");
867         //RNA_def_property_update(prop, 0, "rna_Armature_update_data");
868         
869         /* Number fields */
870 // XXX depreceated ....... old animviz for armatures only
871                 /* ghost/onionskining settings */
872         prop= RNA_def_property(srna, "ghost_step", PROP_INT, PROP_NONE);
873         RNA_def_property_int_sdna(prop, NULL, "ghostep");
874         RNA_def_property_range(prop, 0, 30);
875         RNA_def_property_ui_text(prop, "Ghosting Step", "Number of frame steps on either side of current frame to show as ghosts (only for 'Around Current Frame' Onion-skinning method)");
876         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
877         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
878         
879         prop= RNA_def_property(srna, "ghost_size", PROP_INT, PROP_NONE);
880         RNA_def_property_int_sdna(prop, NULL, "ghostsize");
881         RNA_def_property_range(prop, 1, 20);
882         RNA_def_property_ui_text(prop, "Ghosting Frame Step", "Frame step for Ghosts (not for 'On Keyframes' Onion-skinning method)");
883         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
884         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
885         
886         prop= RNA_def_property(srna, "ghost_frame_start", PROP_INT, PROP_TIME);
887         RNA_def_property_int_sdna(prop, NULL, "ghostsf");
888         RNA_def_property_int_funcs(prop, NULL, "rna_Armature_ghost_start_frame_set", NULL);
889         RNA_def_property_ui_text(prop, "Ghosting Start Frame", "Starting frame of range of Ghosts to display (not for 'Around Current Frame' Onion-skinning method)");
890         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
891         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
892         
893         prop= RNA_def_property(srna, "ghost_frame_end", PROP_INT, PROP_TIME);
894         RNA_def_property_int_sdna(prop, NULL, "ghostef");
895         RNA_def_property_int_funcs(prop, NULL, "rna_Armature_ghost_end_frame_set", NULL);
896         RNA_def_property_ui_text(prop, "Ghosting End Frame", "End frame of range of Ghosts to display (not for 'Around Current Frame' Onion-skinning method)");
897         RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
898         RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
899 // XXX depreceated ....... old animviz for armatures only       
900 }
901
902 void RNA_def_armature(BlenderRNA *brna)
903 {
904         rna_def_armature(brna);
905         rna_def_bone(brna);
906         rna_def_edit_bone(brna);
907 }
908
909 #endif