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