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