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