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