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