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