Cleanup: rename the curveInX etc bbone DNA fields to curve_in_x etc.
[blender.git] / source / blender / makesrna / intern / rna_armature.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup RNA
19  */
20
21 #include <stdlib.h>
22
23 #include "BLI_math.h"
24
25 #include "RNA_access.h"
26 #include "RNA_define.h"
27
28 #include "rna_internal.h"
29
30 #include "DNA_armature_types.h"
31 #include "DNA_object_types.h"
32 #include "DNA_scene_types.h"
33
34 #include "WM_api.h"
35 #include "WM_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #  include "BKE_action.h"
40 #  include "BKE_context.h"
41 #  include "BKE_global.h"
42 #  include "BKE_idprop.h"
43 #  include "BKE_main.h"
44
45 #  include "ED_armature.h"
46 #  include "BKE_armature.h"
47
48 #  include "DEG_depsgraph.h"
49 #  include "DEG_depsgraph_build.h"
50
51 static void rna_Armature_update_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
52 {
53   ID *id = ptr->id.data;
54
55   DEG_id_tag_update(id, 0);
56   WM_main_add_notifier(NC_GEOM | ND_DATA, id);
57   /*WM_main_add_notifier(NC_OBJECT|ND_POSE, NULL); */
58 }
59
60 static void rna_Armature_dependency_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
61 {
62   ID *id = ptr->id.data;
63
64   DEG_relations_tag_update(bmain);
65
66   DEG_id_tag_update(id, 0);
67   WM_main_add_notifier(NC_GEOM | ND_DATA, id);
68 }
69
70 static void rna_Armature_act_bone_set(PointerRNA *ptr, PointerRNA value)
71 {
72   bArmature *arm = (bArmature *)ptr->data;
73
74   if (value.id.data == NULL && value.data == NULL) {
75     arm->act_bone = NULL;
76   }
77   else {
78     if (value.id.data != arm) {
79       Object *ob = (Object *)value.id.data;
80
81       if (GS(ob->id.name) != ID_OB || (ob->data != arm)) {
82         printf("ERROR: armature set active bone - new active doesn't come from this armature\n");
83         return;
84       }
85     }
86
87     arm->act_bone = value.data;
88     arm->act_bone->flag |= BONE_SELECTED;
89   }
90 }
91
92 static void rna_Armature_act_edit_bone_set(PointerRNA *ptr, PointerRNA value)
93 {
94   bArmature *arm = (bArmature *)ptr->data;
95
96   if (value.id.data == NULL && value.data == NULL) {
97     arm->act_edbone = NULL;
98   }
99   else {
100     if (value.id.data != arm) {
101       /* raise an error! */
102     }
103     else {
104       arm->act_edbone = value.data;
105       ((EditBone *)arm->act_edbone)->flag |= BONE_SELECTED;
106     }
107   }
108 }
109
110 static EditBone *rna_Armature_edit_bone_new(bArmature *arm, ReportList *reports, const char *name)
111 {
112   if (arm->edbo == NULL) {
113     BKE_reportf(reports,
114                 RPT_ERROR,
115                 "Armature '%s' not in edit mode, cannot add an editbone",
116                 arm->id.name + 2);
117     return NULL;
118   }
119   return ED_armature_ebone_add(arm, name);
120 }
121
122 static void rna_Armature_edit_bone_remove(bArmature *arm,
123                                           ReportList *reports,
124                                           PointerRNA *ebone_ptr)
125 {
126   EditBone *ebone = ebone_ptr->data;
127   if (arm->edbo == NULL) {
128     BKE_reportf(reports,
129                 RPT_ERROR,
130                 "Armature '%s' not in edit mode, cannot remove an editbone",
131                 arm->id.name + 2);
132     return;
133   }
134
135   if (BLI_findindex(arm->edbo, ebone) == -1) {
136     BKE_reportf(reports,
137                 RPT_ERROR,
138                 "Armature '%s' does not contain bone '%s'",
139                 arm->id.name + 2,
140                 ebone->name);
141     return;
142   }
143
144   ED_armature_ebone_remove(arm, ebone);
145   RNA_POINTER_INVALIDATE(ebone_ptr);
146 }
147
148 static void rna_Armature_update_layers(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
149 {
150   bArmature *arm = ptr->id.data;
151   Object *ob;
152
153   /* proxy lib exception, store it here so we can restore layers on file
154    * load, since it would otherwise get lost due to being linked data */
155   for (ob = bmain->objects.first; ob; ob = ob->id.next) {
156     if (ob->data == arm && ob->pose)
157       ob->pose->proxy_layer = arm->layer;
158   }
159
160   DEG_id_tag_update(&arm->id, ID_RECALC_COPY_ON_WRITE);
161   WM_main_add_notifier(NC_GEOM | ND_DATA, arm);
162 }
163
164 static void rna_Armature_redraw_data(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
165 {
166   ID *id = ptr->id.data;
167
168   DEG_id_tag_update(id, ID_RECALC_COPY_ON_WRITE);
169   WM_main_add_notifier(NC_GEOM | ND_DATA, id);
170 }
171
172 /* called whenever a bone is renamed */
173 static void rna_Bone_update_renamed(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
174 {
175   ID *id = ptr->id.data;
176
177   /* redraw view */
178   WM_main_add_notifier(NC_GEOM | ND_DATA, id);
179
180   /* update animation channels */
181   WM_main_add_notifier(NC_ANIMATION | ND_ANIMCHAN, id);
182 }
183
184 static void rna_Bone_select_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
185 {
186   ID *id = ptr->id.data;
187
188   /* 1) special updates for cases where rigs try to hook into armature drawing stuff
189    *    e.g. Mask Modifier - 'Armature' option
190    * 2) tag armature for copy-on-write, so that selection status (set by addons)
191    *    will update properly, like standard tools do already
192    */
193   if (id) {
194     if (GS(id->name) == ID_AR) {
195       bArmature *arm = (bArmature *)id;
196
197       if (arm->flag & ARM_HAS_VIZ_DEPS) {
198         DEG_id_tag_update(id, ID_RECALC_GEOMETRY);
199       }
200
201       DEG_id_tag_update(id, ID_RECALC_COPY_ON_WRITE);
202     }
203     else if (GS(id->name) == ID_OB) {
204       Object *ob = (Object *)id;
205       bArmature *arm = (bArmature *)ob->data;
206
207       if (arm->flag & ARM_HAS_VIZ_DEPS) {
208         DEG_id_tag_update(id, ID_RECALC_GEOMETRY);
209       }
210
211       DEG_id_tag_update(&arm->id, ID_RECALC_COPY_ON_WRITE);
212     }
213   }
214
215   WM_main_add_notifier(NC_GEOM | ND_DATA, id);
216
217   /* spaces that show animation data of the selected bone need updating */
218   WM_main_add_notifier(NC_ANIMATION | ND_ANIMCHAN, id);
219 }
220
221 static char *rna_Bone_path(PointerRNA *ptr)
222 {
223   ID *id = ptr->id.data;
224   Bone *bone = (Bone *)ptr->data;
225   char name_esc[sizeof(bone->name) * 2];
226
227   BLI_strescape(name_esc, bone->name, sizeof(name_esc));
228
229   /* special exception for trying to get the path where ID-block is Object
230    * - this will be assumed to be from a Pose Bone...
231    */
232   if (id) {
233     if (GS(id->name) == ID_OB) {
234       return BLI_sprintfN("pose.bones[\"%s\"].bone", name_esc);
235     }
236   }
237
238   /* from armature... */
239   return BLI_sprintfN("bones[\"%s\"]", name_esc);
240 }
241
242 static IDProperty *rna_Bone_idprops(PointerRNA *ptr, bool create)
243 {
244   Bone *bone = ptr->data;
245
246   if (create && !bone->prop) {
247     IDPropertyTemplate val = {0};
248     bone->prop = IDP_New(IDP_GROUP, &val, "RNA_Bone ID properties");
249   }
250
251   return bone->prop;
252 }
253
254 static IDProperty *rna_EditBone_idprops(PointerRNA *ptr, bool create)
255 {
256   EditBone *ebone = ptr->data;
257
258   if (create && !ebone->prop) {
259     IDPropertyTemplate val = {0};
260     ebone->prop = IDP_New(IDP_GROUP, &val, "RNA_EditBone ID properties");
261   }
262
263   return ebone->prop;
264 }
265
266 /* Update the layers_used variable after bones are moved between layer
267  * NOTE: Used to be done in drawing code in 2.7, but that won't work with
268  *       Copy-on-Write, as drawing uses evaluated copies.
269  */
270 static void rna_Armature_layer_used_refresh(bArmature *arm, ListBase *bones)
271 {
272   for (Bone *bone = bones->first; bone; bone = bone->next) {
273     arm->layer_used |= bone->layer;
274     rna_Armature_layer_used_refresh(arm, &bone->childbase);
275   }
276 }
277
278 static void rna_bone_layer_set(int *layer, const bool *values)
279 {
280   int i, tot = 0;
281
282   /* ensure we always have some layer selected */
283   for (i = 0; i < 32; i++)
284     if (values[i])
285       tot++;
286
287   if (tot == 0)
288     return;
289
290   for (i = 0; i < 32; i++) {
291     if (values[i])
292       *layer |= (1u << i);
293     else
294       *layer &= ~(1u << i);
295   }
296 }
297
298 static void rna_Bone_layer_set(PointerRNA *ptr, const bool *values)
299 {
300   bArmature *arm = (bArmature *)ptr->id.data;
301   Bone *bone = (Bone *)ptr->data;
302
303   rna_bone_layer_set(&bone->layer, values);
304
305   arm->layer_used = 0;
306   rna_Armature_layer_used_refresh(arm, &arm->bonebase);
307 }
308
309 static void rna_Armature_layer_set(PointerRNA *ptr, const bool *values)
310 {
311   bArmature *arm = (bArmature *)ptr->data;
312   int i, tot = 0;
313
314   /* ensure we always have some layer selected */
315   for (i = 0; i < 32; i++)
316     if (values[i])
317       tot++;
318
319   if (tot == 0)
320     return;
321
322   for (i = 0; i < 32; i++) {
323     if (values[i])
324       arm->layer |= (1u << i);
325     else
326       arm->layer &= ~(1u << i);
327   }
328 }
329
330 static void rna_EditBone_name_set(PointerRNA *ptr, const char *value)
331 {
332   bArmature *arm = (bArmature *)ptr->id.data;
333   EditBone *ebone = (EditBone *)ptr->data;
334   char oldname[sizeof(ebone->name)], newname[sizeof(ebone->name)];
335
336   /* need to be on the stack */
337   BLI_strncpy_utf8(newname, value, sizeof(ebone->name));
338   BLI_strncpy(oldname, ebone->name, sizeof(ebone->name));
339
340   BLI_assert(BKE_id_is_in_global_main(&arm->id));
341   ED_armature_bone_rename(G_MAIN, arm, oldname, newname);
342 }
343
344 static void rna_Bone_name_set(PointerRNA *ptr, const char *value)
345 {
346   bArmature *arm = (bArmature *)ptr->id.data;
347   Bone *bone = (Bone *)ptr->data;
348   char oldname[sizeof(bone->name)], newname[sizeof(bone->name)];
349
350   /* need to be on the stack */
351   BLI_strncpy_utf8(newname, value, sizeof(bone->name));
352   BLI_strncpy(oldname, bone->name, sizeof(bone->name));
353
354   BLI_assert(BKE_id_is_in_global_main(&arm->id));
355   ED_armature_bone_rename(G_MAIN, arm, oldname, newname);
356 }
357
358 static void rna_EditBone_layer_set(PointerRNA *ptr, const bool values[])
359 {
360   EditBone *data = (EditBone *)(ptr->data);
361   rna_bone_layer_set(&data->layer, values);
362 }
363
364 static void rna_EditBone_connected_check(EditBone *ebone)
365 {
366   if (ebone->parent) {
367     if (ebone->flag & BONE_CONNECTED) {
368       /* Attach this bone to its parent */
369       copy_v3_v3(ebone->head, ebone->parent->tail);
370
371       if (ebone->flag & BONE_ROOTSEL)
372         ebone->parent->flag |= BONE_TIPSEL;
373     }
374     else if (!(ebone->parent->flag & BONE_ROOTSEL)) {
375       ebone->parent->flag &= ~BONE_TIPSEL;
376     }
377   }
378 }
379
380 static void rna_EditBone_connected_set(PointerRNA *ptr, bool value)
381 {
382   EditBone *ebone = (EditBone *)(ptr->data);
383
384   if (value)
385     ebone->flag |= BONE_CONNECTED;
386   else
387     ebone->flag &= ~BONE_CONNECTED;
388
389   rna_EditBone_connected_check(ebone);
390 }
391
392 static PointerRNA rna_EditBone_parent_get(PointerRNA *ptr)
393 {
394   EditBone *data = (EditBone *)(ptr->data);
395   return rna_pointer_inherit_refine(ptr, &RNA_EditBone, data->parent);
396 }
397
398 static void rna_EditBone_parent_set(PointerRNA *ptr, PointerRNA value)
399 {
400   EditBone *ebone = (EditBone *)(ptr->data);
401   EditBone *pbone, *parbone = (EditBone *)value.data;
402
403   if (parbone == NULL) {
404     if (ebone->parent && !(ebone->parent->flag & BONE_ROOTSEL))
405       ebone->parent->flag &= ~BONE_TIPSEL;
406
407     ebone->parent = NULL;
408     ebone->flag &= ~BONE_CONNECTED;
409   }
410   else {
411     /* within same armature */
412     if (value.id.data != ptr->id.data)
413       return;
414
415     /* make sure this is a valid child */
416     if (parbone == ebone)
417       return;
418
419     for (pbone = parbone->parent; pbone; pbone = pbone->parent)
420       if (pbone == ebone)
421         return;
422
423     ebone->parent = parbone;
424     rna_EditBone_connected_check(ebone);
425   }
426 }
427
428 static void rna_EditBone_matrix_get(PointerRNA *ptr, float *values)
429 {
430   EditBone *ebone = (EditBone *)(ptr->data);
431   ED_armature_ebone_to_mat4(ebone, (float(*)[4])values);
432 }
433
434 static void rna_EditBone_matrix_set(PointerRNA *ptr, const float *values)
435 {
436   EditBone *ebone = (EditBone *)(ptr->data);
437   ED_armature_ebone_from_mat4(ebone, (float(*)[4])values);
438 }
439
440 static void rna_Bone_bbone_handle_update(Main *bmain, Scene *scene, PointerRNA *ptr)
441 {
442   bArmature *arm = (bArmature *)ptr->id.data;
443   Bone *bone = (Bone *)ptr->data;
444
445   /* Update all users of this armature after changing B-Bone handles. */
446   for (Object *obt = bmain->objects.first; obt; obt = obt->id.next) {
447     if (obt->data == arm && obt->pose) {
448       bPoseChannel *pchan = BKE_pose_channel_find_name(obt->pose, bone->name);
449
450       if (pchan && pchan->bone == bone) {
451         BKE_pchan_rebuild_bbone_handles(obt->pose, pchan);
452         DEG_id_tag_update(&obt->id, ID_RECALC_COPY_ON_WRITE);
453       }
454     }
455   }
456
457   rna_Armature_dependency_update(bmain, scene, ptr);
458 }
459
460 static PointerRNA rna_EditBone_bbone_prev_get(PointerRNA *ptr)
461 {
462   EditBone *data = (EditBone *)(ptr->data);
463   return rna_pointer_inherit_refine(ptr, &RNA_EditBone, data->bbone_prev);
464 }
465
466 static void rna_EditBone_bbone_prev_set(PointerRNA *ptr, PointerRNA value)
467 {
468   EditBone *ebone = (EditBone *)(ptr->data);
469   EditBone *hbone = (EditBone *)value.data;
470
471   /* Within the same armature? */
472   if (hbone == NULL || value.id.data == ptr->id.data) {
473     ebone->bbone_prev = hbone;
474   }
475 }
476
477 static void rna_Bone_bbone_prev_set(PointerRNA *ptr, PointerRNA value)
478 {
479   Bone *bone = (Bone *)ptr->data;
480   Bone *hbone = (Bone *)value.data;
481
482   /* Within the same armature? */
483   if (hbone == NULL || value.id.data == ptr->id.data) {
484     bone->bbone_prev = hbone;
485   }
486 }
487
488 static PointerRNA rna_EditBone_bbone_next_get(PointerRNA *ptr)
489 {
490   EditBone *data = (EditBone *)(ptr->data);
491   return rna_pointer_inherit_refine(ptr, &RNA_EditBone, data->bbone_next);
492 }
493
494 static void rna_EditBone_bbone_next_set(PointerRNA *ptr, PointerRNA value)
495 {
496   EditBone *ebone = (EditBone *)(ptr->data);
497   EditBone *hbone = (EditBone *)value.data;
498
499   /* Within the same armature? */
500   if (hbone == NULL || value.id.data == ptr->id.data) {
501     ebone->bbone_next = hbone;
502   }
503 }
504
505 static void rna_Bone_bbone_next_set(PointerRNA *ptr, PointerRNA value)
506 {
507   Bone *bone = (Bone *)ptr->data;
508   Bone *hbone = (Bone *)value.data;
509
510   /* Within the same armature? */
511   if (hbone == NULL || value.id.data == ptr->id.data) {
512     bone->bbone_next = hbone;
513   }
514 }
515
516 static void rna_Armature_editbone_transform_update(Main *bmain, Scene *scene, PointerRNA *ptr)
517 {
518   bArmature *arm = (bArmature *)ptr->id.data;
519   EditBone *ebone = (EditBone *)ptr->data;
520   EditBone *child, *eboflip;
521
522   /* update our parent */
523   if (ebone->parent && ebone->flag & BONE_CONNECTED)
524     copy_v3_v3(ebone->parent->tail, ebone->head);
525
526   /* update our children if necessary */
527   for (child = arm->edbo->first; child; child = child->next)
528     if (child->parent == ebone && (child->flag & BONE_CONNECTED))
529       copy_v3_v3(child->head, ebone->tail);
530
531   if (arm->flag & ARM_MIRROR_EDIT) {
532     eboflip = ED_armature_ebone_get_mirrored(arm->edbo, ebone);
533
534     if (eboflip) {
535       eboflip->roll = -ebone->roll;
536
537       eboflip->head[0] = -ebone->head[0];
538       eboflip->tail[0] = -ebone->tail[0];
539
540       /* update our parent */
541       if (eboflip->parent && eboflip->flag & BONE_CONNECTED)
542         copy_v3_v3(eboflip->parent->tail, eboflip->head);
543
544       /* update our children if necessary */
545       for (child = arm->edbo->first; child; child = child->next)
546         if (child->parent == eboflip && (child->flag & BONE_CONNECTED))
547           copy_v3_v3(child->head, eboflip->tail);
548     }
549   }
550
551   rna_Armature_update_data(bmain, scene, ptr);
552 }
553
554 static void rna_Armature_bones_next(CollectionPropertyIterator *iter)
555 {
556   ListBaseIterator *internal = &iter->internal.listbase;
557   Bone *bone = (Bone *)internal->link;
558
559   if (bone->childbase.first)
560     internal->link = (Link *)bone->childbase.first;
561   else if (bone->next)
562     internal->link = (Link *)bone->next;
563   else {
564     internal->link = NULL;
565
566     do {
567       bone = bone->parent;
568       if (bone && bone->next) {
569         internal->link = (Link *)bone->next;
570         break;
571       }
572     } while (bone);
573   }
574
575   iter->valid = (internal->link != NULL);
576 }
577
578 static bool rna_Armature_is_editmode_get(PointerRNA *ptr)
579 {
580   bArmature *arm = (bArmature *)ptr->id.data;
581   return (arm->edbo != NULL);
582 }
583
584 static void rna_Armature_transform(struct bArmature *arm, Main *bmain, float *mat)
585 {
586   ED_armature_transform(bmain, arm, (float(*)[4])mat, true);
587 }
588
589 #else
590
591 /* Settings for curved bbone settings -
592  * The posemode values get applied over the top of the editmode ones. */
593 void rna_def_bone_curved_common(StructRNA *srna, bool is_posebone)
594 {
595 #  define RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone) \
596     { \
597       if (is_posebone) \
598         RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update"); \
599       else \
600         RNA_def_property_update(prop, 0, "rna_Armature_update_data"); \
601     } \
602     ((void)0)
603
604   PropertyRNA *prop;
605
606   /* Roll In/Out */
607   prop = RNA_def_property(srna, "bbone_rollin", PROP_FLOAT, PROP_ANGLE);
608   RNA_def_property_float_sdna(prop, NULL, "roll1");
609   RNA_def_property_range(prop, -M_PI * 2.0, M_PI * 2.0);
610   RNA_def_property_ui_text(
611       prop, "Roll In", "Roll offset for the start of the B-Bone, adjusts twist");
612   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
613
614   prop = RNA_def_property(srna, "bbone_rollout", PROP_FLOAT, PROP_ANGLE);
615   RNA_def_property_float_sdna(prop, NULL, "roll2");
616   RNA_def_property_range(prop, -M_PI * 2.0, M_PI * 2.0);
617   RNA_def_property_ui_text(
618       prop, "Roll Out", "Roll offset for the end of the B-Bone, adjusts twist");
619   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
620
621   if (is_posebone == false) {
622     prop = RNA_def_property(srna, "use_endroll_as_inroll", PROP_BOOLEAN, PROP_NONE);
623     RNA_def_property_ui_text(
624         prop, "Inherit End Roll", "Use Roll Out of parent bone as Roll In of its children");
625     RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_ADD_PARENT_END_ROLL);
626     RNA_def_property_update(prop, 0, "rna_Armature_update_data");
627   }
628
629   /* Curve X/Y Offsets */
630   prop = RNA_def_property(srna, "bbone_curveinx", PROP_FLOAT, PROP_NONE);
631   RNA_def_property_float_sdna(prop, NULL, "curve_in_x");
632   RNA_def_property_range(prop, -5.0f, 5.0f);
633   RNA_def_property_ui_text(
634       prop, "In X", "X-axis handle offset for start of the B-Bone's curve, adjusts curvature");
635   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
636
637   prop = RNA_def_property(srna, "bbone_curveiny", PROP_FLOAT, PROP_NONE);
638   RNA_def_property_float_sdna(prop, NULL, "curve_in_y");
639   RNA_def_property_range(prop, -5.0f, 5.0f);
640   RNA_def_property_ui_text(
641       prop, "In Y", "Y-axis handle offset for start of the B-Bone's curve, adjusts curvature");
642   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
643
644   prop = RNA_def_property(srna, "bbone_curveoutx", PROP_FLOAT, PROP_NONE);
645   RNA_def_property_float_sdna(prop, NULL, "curve_out_x");
646   RNA_def_property_range(prop, -5.0f, 5.0f);
647   RNA_def_property_ui_text(
648       prop, "Out X", "X-axis handle offset for end of the B-Bone's curve, adjusts curvature");
649   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
650
651   prop = RNA_def_property(srna, "bbone_curveouty", PROP_FLOAT, PROP_NONE);
652   RNA_def_property_float_sdna(prop, NULL, "curve_out_y");
653   RNA_def_property_range(prop, -5.0f, 5.0f);
654   RNA_def_property_ui_text(
655       prop, "Out Y", "Y-axis handle offset for end of the B-Bone's curve, adjusts curvature");
656   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
657
658   /* Ease In/Out */
659   prop = RNA_def_property(srna, "bbone_easein", PROP_FLOAT, PROP_NONE);
660   RNA_def_property_float_sdna(prop, NULL, "ease1");
661   RNA_def_property_range(prop, -5.0f, 5.0f);
662   RNA_def_property_float_default(prop, 1.0f);
663   RNA_def_property_ui_text(prop, "Ease In", "Length of first Bezier Handle (for B-Bones only)");
664   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
665
666   prop = RNA_def_property(srna, "bbone_easeout", PROP_FLOAT, PROP_NONE);
667   RNA_def_property_float_sdna(prop, NULL, "ease2");
668   RNA_def_property_range(prop, -5.0f, 5.0f);
669   RNA_def_property_float_default(prop, 1.0f);
670   RNA_def_property_ui_text(prop, "Ease Out", "Length of second Bezier Handle (for B-Bones only)");
671   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
672
673   /* Scale In/Out */
674   prop = RNA_def_property(srna, "bbone_scaleinx", PROP_FLOAT, PROP_NONE);
675   RNA_def_property_float_sdna(prop, NULL, "scale_in_x");
676   RNA_def_property_flag(prop, PROP_PROPORTIONAL);
677   RNA_def_property_range(prop, 0.0f, 5.0f);
678   RNA_def_property_float_default(prop, 1.0f);
679   RNA_def_property_ui_text(prop,
680                            "Scale In X",
681                            "X-axis scale factor for start of the B-Bone, "
682                            "adjusts thickness (for tapering effects)");
683   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
684
685   prop = RNA_def_property(srna, "bbone_scaleiny", PROP_FLOAT, PROP_NONE);
686   RNA_def_property_float_sdna(prop, NULL, "scale_in_y");
687   RNA_def_property_flag(prop, PROP_PROPORTIONAL);
688   RNA_def_property_range(prop, 0.0f, 5.0f);
689   RNA_def_property_float_default(prop, 1.0f);
690   RNA_def_property_ui_text(prop,
691                            "Scale In Y",
692                            "Y-axis scale factor for start of the B-Bone, "
693                            "adjusts thickness (for tapering effects)");
694   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
695
696   prop = RNA_def_property(srna, "bbone_scaleoutx", PROP_FLOAT, PROP_NONE);
697   RNA_def_property_float_sdna(prop, NULL, "scale_out_x");
698   RNA_def_property_flag(prop, PROP_PROPORTIONAL);
699   RNA_def_property_range(prop, 0.0f, 5.0f);
700   RNA_def_property_float_default(prop, 1.0f);
701   RNA_def_property_ui_text(prop,
702                            "Scale Out X",
703                            "X-axis scale factor for end of the B-Bone, "
704                            "adjusts thickness (for tapering effects)");
705   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
706
707   prop = RNA_def_property(srna, "bbone_scaleouty", PROP_FLOAT, PROP_NONE);
708   RNA_def_property_float_sdna(prop, NULL, "scale_out_y");
709   RNA_def_property_flag(prop, PROP_PROPORTIONAL);
710   RNA_def_property_range(prop, 0.0f, 5.0f);
711   RNA_def_property_float_default(prop, 1.0f);
712   RNA_def_property_ui_text(prop,
713                            "Scale Out Y",
714                            "Y-axis scale factor for end of the B-Bone, "
715                            "adjusts thickness (for tapering effects)");
716   RNA_DEF_CURVEBONE_UPDATE(prop, is_posebone);
717
718 #  undef RNA_DEF_CURVEBONE_UPDATE
719 }
720
721 static void rna_def_bone_common(StructRNA *srna, int editbone)
722 {
723   static const EnumPropertyItem prop_bbone_handle_type[] = {
724       {BBONE_HANDLE_AUTO,
725        "AUTO",
726        0,
727        "Automatic",
728        "Use connected parent and children to compute the handle"},
729       {BBONE_HANDLE_ABSOLUTE,
730        "ABSOLUTE",
731        0,
732        "Absolute",
733        "Use the position of the specified bone to compute the handle"},
734       {BBONE_HANDLE_RELATIVE,
735        "RELATIVE",
736        0,
737        "Relative",
738        "Use the offset of the specified bone from rest pose to compute the handle"},
739       {BBONE_HANDLE_TANGENT,
740        "TANGENT",
741        0,
742        "Tangent",
743        "Use the orientation of the specified bone to compute the handle, ignoring the location"},
744       {0, NULL, 0, NULL, NULL},
745   };
746
747   PropertyRNA *prop;
748
749   /* strings */
750   prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
751   RNA_def_property_string_sdna(prop, NULL, "name");
752   RNA_def_property_ui_text(prop, "Name", "");
753   RNA_def_struct_name_property(srna, prop);
754   if (editbone) {
755     RNA_def_property_string_funcs(prop, NULL, NULL, "rna_EditBone_name_set");
756   }
757   else {
758     RNA_def_property_string_funcs(prop, NULL, NULL, "rna_Bone_name_set");
759   }
760   RNA_def_property_update(prop, 0, "rna_Bone_update_renamed");
761
762   /* flags */
763   prop = RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER_MEMBER);
764   RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
765   RNA_def_property_array(prop, 32);
766   if (editbone) {
767     RNA_def_property_boolean_funcs(prop, NULL, "rna_EditBone_layer_set");
768   }
769   else {
770     RNA_def_property_boolean_funcs(prop, NULL, "rna_Bone_layer_set");
771   }
772   RNA_def_property_ui_text(prop, "Layers", "Layers bone exists in");
773   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
774
775   prop = RNA_def_property(srna, "use_connect", PROP_BOOLEAN, PROP_NONE);
776   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_CONNECTED);
777   if (editbone) {
778     RNA_def_property_boolean_funcs(prop, NULL, "rna_EditBone_connected_set");
779   }
780   else {
781     RNA_def_property_clear_flag(prop, PROP_EDITABLE);
782   }
783   RNA_def_property_ui_text(
784       prop, "Connected", "When bone has a parent, bone's head is stuck to the parent's tail");
785   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
786
787   prop = RNA_def_property(srna, "use_inherit_rotation", PROP_BOOLEAN, PROP_NONE);
788   RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_HINGE);
789   RNA_def_property_ui_text(
790       prop, "Inherit Rotation", "Bone inherits rotation or scale from parent bone");
791   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
792
793   prop = RNA_def_property(srna, "use_envelope_multiply", PROP_BOOLEAN, PROP_NONE);
794   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_MULT_VG_ENV);
795   RNA_def_property_ui_text(
796       prop,
797       "Multiply Vertex Group with Envelope",
798       "When deforming bone, multiply effects of Vertex Group weights with Envelope influence");
799   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
800
801   prop = RNA_def_property(srna, "use_deform", PROP_BOOLEAN, PROP_NONE);
802   RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_DEFORM);
803   RNA_def_property_ui_text(prop, "Deform", "Enable Bone to deform geometry");
804   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
805
806   prop = RNA_def_property(srna, "use_inherit_scale", PROP_BOOLEAN, PROP_NONE);
807   RNA_def_property_ui_text(prop, "Inherit Scale", "Bone inherits scaling from parent bone");
808   RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_SCALE);
809   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
810
811   prop = RNA_def_property(srna, "use_local_location", PROP_BOOLEAN, PROP_NONE);
812   RNA_def_property_ui_text(prop, "Local Location", "Bone location is set in local space");
813   RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_LOCAL_LOCATION);
814   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
815
816   prop = RNA_def_property(srna, "use_relative_parent", PROP_BOOLEAN, PROP_NONE);
817   RNA_def_property_ui_text(
818       prop, "Relative Parenting", "Object children will use relative transform, like deform");
819   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_RELATIVE_PARENTING);
820   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
821
822   prop = RNA_def_property(srna, "show_wire", PROP_BOOLEAN, PROP_NONE);
823   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_DRAWWIRE);
824   RNA_def_property_ui_text(prop,
825                            "Display Wire",
826                            "Bone is always drawn as Wireframe regardless of viewport draw mode "
827                            "(useful for non-obstructive custom bone shapes)");
828   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
829
830   /* XXX: use_cyclic_offset is deprecated in 2.5. May/may not return */
831   prop = RNA_def_property(srna, "use_cyclic_offset", PROP_BOOLEAN, PROP_NONE);
832   RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", BONE_NO_CYCLICOFFSET);
833   RNA_def_property_ui_text(
834       prop,
835       "Cyclic Offset",
836       "When bone doesn't have a parent, it receives cyclic offset effects (Deprecated)");
837   //                         "When bone doesn't have a parent, it receives cyclic offset effects");
838   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
839
840   prop = RNA_def_property(srna, "hide_select", PROP_BOOLEAN, PROP_NONE);
841   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_UNSELECTABLE);
842   RNA_def_property_ui_text(prop, "Selectable", "Bone is able to be selected");
843   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
844
845   /* Number values */
846   /* envelope deform settings */
847   prop = RNA_def_property(srna, "envelope_distance", PROP_FLOAT, PROP_DISTANCE);
848   RNA_def_property_float_sdna(prop, NULL, "dist");
849   RNA_def_property_range(prop, 0.0f, 1000.0f);
850   RNA_def_property_ui_text(
851       prop, "Envelope Deform Distance", "Bone deformation distance (for Envelope deform only)");
852   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
853
854   prop = RNA_def_property(srna, "envelope_weight", PROP_FLOAT, PROP_NONE);
855   RNA_def_property_float_sdna(prop, NULL, "weight");
856   RNA_def_property_range(prop, 0.0f, 1000.0f);
857   RNA_def_property_ui_text(
858       prop, "Envelope Deform Weight", "Bone deformation weight (for Envelope deform only)");
859   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
860
861   prop = RNA_def_property(srna, "head_radius", PROP_FLOAT, PROP_DISTANCE);
862   if (editbone) {
863     RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
864   }
865   else {
866     RNA_def_property_update(prop, 0, "rna_Armature_update_data");
867   }
868   RNA_def_property_float_sdna(prop, NULL, "rad_head");
869   /* XXX range is 0 to lim, where lim = 10000.0f * MAX2(1.0, view3d->grid); */
870   /*RNA_def_property_range(prop, 0, 1000); */
871   RNA_def_property_ui_range(prop, 0.01, 100, 0.1, 3);
872   RNA_def_property_ui_text(
873       prop, "Envelope Head Radius", "Radius of head of bone (for Envelope deform only)");
874
875   prop = RNA_def_property(srna, "tail_radius", PROP_FLOAT, PROP_DISTANCE);
876   if (editbone) {
877     RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
878   }
879   else {
880     RNA_def_property_update(prop, 0, "rna_Armature_update_data");
881   }
882   RNA_def_property_float_sdna(prop, NULL, "rad_tail");
883   /* XXX range is 0 to lim, where lim = 10000.0f * MAX2(1.0, view3d->grid); */
884   /*RNA_def_property_range(prop, 0, 1000); */
885   RNA_def_property_ui_range(prop, 0.01, 100, 0.1, 3);
886   RNA_def_property_ui_text(
887       prop, "Envelope Tail Radius", "Radius of tail of bone (for Envelope deform only)");
888
889   /* b-bones deform settings */
890   prop = RNA_def_property(srna, "bbone_segments", PROP_INT, PROP_NONE);
891   RNA_def_property_int_sdna(prop, NULL, "segments");
892   RNA_def_property_range(prop, 1, 32);
893   RNA_def_property_ui_text(
894       prop, "B-Bone Segments", "Number of subdivisions of bone (for B-Bones only)");
895   RNA_def_property_update(prop, 0, "rna_Armature_dependency_update");
896
897   prop = RNA_def_property(srna, "bbone_x", PROP_FLOAT, PROP_NONE);
898   RNA_def_property_float_sdna(prop, NULL, "xwidth");
899   RNA_def_property_range(prop, 0.0f, 1000.0f);
900   RNA_def_property_ui_text(prop, "B-Bone Display X Width", "B-Bone X size");
901   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
902
903   prop = RNA_def_property(srna, "bbone_z", PROP_FLOAT, PROP_NONE);
904   RNA_def_property_float_sdna(prop, NULL, "zwidth");
905   RNA_def_property_range(prop, 0.0f, 1000.0f);
906   RNA_def_property_ui_text(prop, "B-Bone Display Z Width", "B-Bone Z size");
907   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
908
909   prop = RNA_def_property(srna, "bbone_handle_type_start", PROP_ENUM, PROP_NONE);
910   RNA_def_property_enum_sdna(prop, NULL, "bbone_prev_type");
911   RNA_def_property_enum_items(prop, prop_bbone_handle_type);
912   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
913   RNA_def_property_ui_text(
914       prop, "B-Bone Start Handle Type", "Selects how the start handle of the B-Bone is computed");
915   RNA_def_property_update(prop, 0, "rna_Armature_dependency_update");
916
917   prop = RNA_def_property(srna, "bbone_custom_handle_start", PROP_POINTER, PROP_NONE);
918   RNA_def_property_pointer_sdna(prop, NULL, "bbone_prev");
919   RNA_def_property_struct_type(prop, editbone ? "EditBone" : "Bone");
920   if (editbone) {
921     RNA_def_property_pointer_funcs(
922         prop, "rna_EditBone_bbone_prev_get", "rna_EditBone_bbone_prev_set", NULL, NULL);
923     RNA_def_property_update(prop, 0, "rna_Armature_dependency_update");
924   }
925   else {
926     RNA_def_property_pointer_funcs(prop, NULL, "rna_Bone_bbone_prev_set", NULL, NULL);
927     RNA_def_property_update(prop, 0, "rna_Bone_bbone_handle_update");
928   }
929   RNA_def_property_flag(prop, PROP_EDITABLE | PROP_PTR_NO_OWNERSHIP);
930   RNA_def_property_ui_text(
931       prop, "B-Bone Start Handle", "Bone that serves as the start handle for the B-Bone curve");
932
933   prop = RNA_def_property(srna, "bbone_handle_type_end", PROP_ENUM, PROP_NONE);
934   RNA_def_property_enum_sdna(prop, NULL, "bbone_next_type");
935   RNA_def_property_enum_items(prop, prop_bbone_handle_type);
936   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
937   RNA_def_property_ui_text(
938       prop, "B-Bone End Handle Type", "Selects how the end handle of the B-Bone is computed");
939   RNA_def_property_update(prop, 0, "rna_Armature_dependency_update");
940
941   prop = RNA_def_property(srna, "bbone_custom_handle_end", PROP_POINTER, PROP_NONE);
942   RNA_def_property_pointer_sdna(prop, NULL, "bbone_next");
943   RNA_def_property_struct_type(prop, editbone ? "EditBone" : "Bone");
944   if (editbone) {
945     RNA_def_property_pointer_funcs(
946         prop, "rna_EditBone_bbone_next_get", "rna_EditBone_bbone_next_set", NULL, NULL);
947     RNA_def_property_update(prop, 0, "rna_Armature_dependency_update");
948   }
949   else {
950     RNA_def_property_pointer_funcs(prop, NULL, "rna_Bone_bbone_next_set", NULL, NULL);
951     RNA_def_property_update(prop, 0, "rna_Bone_bbone_handle_update");
952   }
953   RNA_def_property_flag(prop, PROP_EDITABLE | PROP_PTR_NO_OWNERSHIP);
954   RNA_def_property_ui_text(
955       prop, "B-Bone End Handle", "Bone that serves as the end handle for the B-Bone curve");
956 }
957
958 /* err... bones should not be directly edited (only editbones should be...) */
959 static void rna_def_bone(BlenderRNA *brna)
960 {
961   StructRNA *srna;
962   PropertyRNA *prop;
963
964   srna = RNA_def_struct(brna, "Bone", NULL);
965   RNA_def_struct_ui_text(srna, "Bone", "Bone in an Armature data-block");
966   RNA_def_struct_ui_icon(srna, ICON_BONE_DATA);
967   RNA_def_struct_path_func(srna, "rna_Bone_path");
968   RNA_def_struct_idprops_func(srna, "rna_Bone_idprops");
969
970   /* pointers/collections */
971   /* parent (pointer) */
972   prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
973   RNA_def_property_struct_type(prop, "Bone");
974   RNA_def_property_pointer_sdna(prop, NULL, "parent");
975   RNA_def_property_flag(prop, PROP_PTR_NO_OWNERSHIP);
976   RNA_def_property_ui_text(prop, "Parent", "Parent bone (in same Armature)");
977   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
978
979   /* children (collection) */
980   prop = RNA_def_property(srna, "children", PROP_COLLECTION, PROP_NONE);
981   RNA_def_property_collection_sdna(prop, NULL, "childbase", NULL);
982   RNA_def_property_struct_type(prop, "Bone");
983   RNA_def_property_flag(prop, PROP_PTR_NO_OWNERSHIP);
984   RNA_def_property_ui_text(prop, "Children", "Bones which are children of this bone");
985
986   rna_def_bone_common(srna, 0);
987   rna_def_bone_curved_common(srna, 0);
988
989   /* XXX should we define this in PoseChannel wrapping code instead?
990    *     But PoseChannels directly get some of their flags from here... */
991   prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
992   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_HIDDEN_P);
993   RNA_def_property_ui_text(
994       prop,
995       "Hide",
996       "Bone is not visible when it is not in Edit Mode (i.e. in Object or Pose Modes)");
997   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
998
999   prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
1000   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_SELECTED);
1001   RNA_def_property_ui_text(prop, "Select", "");
1002   RNA_def_property_clear_flag(
1003       prop,
1004       PROP_ANIMATABLE); /* XXX: review whether this could be used for interesting effects... */
1005   RNA_def_property_update(prop, 0, "rna_Bone_select_update");
1006
1007   prop = RNA_def_property(srna, "select_head", PROP_BOOLEAN, PROP_NONE);
1008   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_ROOTSEL);
1009   RNA_def_property_ui_text(prop, "Select Head", "");
1010   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1011   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1012
1013   prop = RNA_def_property(srna, "select_tail", PROP_BOOLEAN, PROP_NONE);
1014   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_TIPSEL);
1015   RNA_def_property_ui_text(prop, "Select Tail", "");
1016   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1017   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1018
1019   /* XXX better matrix descriptions possible (Arystan) */
1020   prop = RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
1021   RNA_def_property_float_sdna(prop, NULL, "bone_mat");
1022   RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_3x3);
1023   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1024   RNA_def_property_ui_text(prop, "Bone Matrix", "3x3 bone matrix");
1025
1026   prop = RNA_def_property(srna, "matrix_local", PROP_FLOAT, PROP_MATRIX);
1027   RNA_def_property_float_sdna(prop, NULL, "arm_mat");
1028   RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
1029   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1030   RNA_def_property_ui_text(
1031       prop, "Bone Armature-Relative Matrix", "4x4 bone matrix relative to armature");
1032
1033   prop = RNA_def_property(srna, "tail", PROP_FLOAT, PROP_TRANSLATION);
1034   RNA_def_property_float_sdna(prop, NULL, "tail");
1035   RNA_def_property_array(prop, 3);
1036   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1037   RNA_def_property_ui_text(prop, "Tail", "Location of tail end of the bone");
1038   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
1039
1040   prop = RNA_def_property(srna, "tail_local", PROP_FLOAT, PROP_TRANSLATION);
1041   RNA_def_property_float_sdna(prop, NULL, "arm_tail");
1042   RNA_def_property_array(prop, 3);
1043   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1044   RNA_def_property_ui_text(
1045       prop, "Armature-Relative Tail", "Location of tail end of the bone relative to armature");
1046   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
1047
1048   prop = RNA_def_property(srna, "head", PROP_FLOAT, PROP_TRANSLATION);
1049   RNA_def_property_float_sdna(prop, NULL, "head");
1050   RNA_def_property_array(prop, 3);
1051   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1052   RNA_def_property_ui_text(
1053       prop, "Head", "Location of head end of the bone relative to its parent");
1054   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
1055
1056   prop = RNA_def_property(srna, "head_local", PROP_FLOAT, PROP_TRANSLATION);
1057   RNA_def_property_float_sdna(prop, NULL, "arm_head");
1058   RNA_def_property_array(prop, 3);
1059   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1060   RNA_def_property_ui_text(
1061       prop, "Armature-Relative Head", "Location of head end of the bone relative to armature");
1062   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
1063
1064   RNA_api_bone(srna);
1065 }
1066
1067 static void rna_def_edit_bone(BlenderRNA *brna)
1068 {
1069   StructRNA *srna;
1070   PropertyRNA *prop;
1071
1072   srna = RNA_def_struct(brna, "EditBone", NULL);
1073   RNA_def_struct_sdna(srna, "EditBone");
1074   RNA_def_struct_idprops_func(srna, "rna_EditBone_idprops");
1075   RNA_def_struct_ui_text(srna, "Edit Bone", "Editmode bone in an Armature data-block");
1076   RNA_def_struct_ui_icon(srna, ICON_BONE_DATA);
1077
1078   RNA_define_verify_sdna(0); /* not in sdna */
1079
1080   prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
1081   RNA_def_property_struct_type(prop, "EditBone");
1082   RNA_def_property_pointer_funcs(
1083       prop, "rna_EditBone_parent_get", "rna_EditBone_parent_set", NULL, NULL);
1084   RNA_def_property_flag(prop, PROP_EDITABLE);
1085   RNA_def_property_ui_text(prop, "Parent", "Parent edit bone (in same Armature)");
1086   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1087
1088   prop = RNA_def_property(srna, "roll", PROP_FLOAT, PROP_ANGLE);
1089   RNA_def_property_float_sdna(prop, NULL, "roll");
1090   RNA_def_property_ui_range(prop, -M_PI * 2, M_PI * 2, 10, 2);
1091   RNA_def_property_ui_text(prop, "Roll", "Bone rotation around head-tail axis");
1092   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1093   RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
1094
1095   prop = RNA_def_property(srna, "head", PROP_FLOAT, PROP_TRANSLATION);
1096   RNA_def_property_float_sdna(prop, NULL, "head");
1097   RNA_def_property_array(prop, 3);
1098   RNA_def_property_ui_text(prop, "Head", "Location of head end of the bone");
1099   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1100   RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
1101
1102   prop = RNA_def_property(srna, "tail", PROP_FLOAT, PROP_TRANSLATION);
1103   RNA_def_property_float_sdna(prop, NULL, "tail");
1104   RNA_def_property_array(prop, 3);
1105   RNA_def_property_ui_text(prop, "Tail", "Location of tail end of the bone");
1106   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1107   RNA_def_property_update(prop, 0, "rna_Armature_editbone_transform_update");
1108
1109   rna_def_bone_common(srna, 1);
1110   rna_def_bone_curved_common(srna, 0);
1111
1112   prop = RNA_def_property(srna, "hide", PROP_BOOLEAN, PROP_NONE);
1113   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_HIDDEN_A);
1114   RNA_def_property_ui_text(prop, "Hide", "Bone is not visible when in Edit Mode");
1115   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1116   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1117
1118   prop = RNA_def_property(srna, "lock", PROP_BOOLEAN, PROP_NONE);
1119   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_EDITMODE_LOCKED);
1120   RNA_def_property_ui_text(prop, "Lock", "Bone is not able to be transformed when in Edit Mode");
1121   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1122   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1123
1124   prop = RNA_def_property(srna, "select", PROP_BOOLEAN, PROP_NONE);
1125   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_SELECTED);
1126   RNA_def_property_ui_text(prop, "Select", "");
1127   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1128   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1129
1130   prop = RNA_def_property(srna, "select_head", PROP_BOOLEAN, PROP_NONE);
1131   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_ROOTSEL);
1132   RNA_def_property_ui_text(prop, "Head Select", "");
1133   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1134   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1135
1136   prop = RNA_def_property(srna, "select_tail", PROP_BOOLEAN, PROP_NONE);
1137   RNA_def_property_boolean_sdna(prop, NULL, "flag", BONE_TIPSEL);
1138   RNA_def_property_ui_text(prop, "Tail Select", "");
1139   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1140   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1141
1142   /* calculated and read only, not actual data access */
1143   prop = RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
1144   /*RNA_def_property_float_sdna(prop, NULL, "");  */ /* doesn't access any real data */
1145   RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
1146   //RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1147   RNA_def_property_flag(prop, PROP_THICK_WRAP); /* no reference to original data */
1148   RNA_def_property_ui_text(
1149       prop,
1150       "Editbone Matrix",
1151       "Matrix combining loc/rot of the bone (head position, direction and roll), "
1152       "in armature space (WARNING: does not include/support bone's length/size)");
1153   RNA_def_property_float_funcs(prop, "rna_EditBone_matrix_get", "rna_EditBone_matrix_set", NULL);
1154
1155   RNA_api_armature_edit_bone(srna);
1156
1157   RNA_define_verify_sdna(1);
1158 }
1159
1160 /* armature.bones.* */
1161 static void rna_def_armature_bones(BlenderRNA *brna, PropertyRNA *cprop)
1162 {
1163   StructRNA *srna;
1164   PropertyRNA *prop;
1165
1166   /*  FunctionRNA *func; */
1167   /*  PropertyRNA *parm; */
1168
1169   RNA_def_property_srna(cprop, "ArmatureBones");
1170   srna = RNA_def_struct(brna, "ArmatureBones", NULL);
1171   RNA_def_struct_sdna(srna, "bArmature");
1172   RNA_def_struct_ui_text(srna, "Armature Bones", "Collection of armature bones");
1173
1174   prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1175   RNA_def_property_struct_type(prop, "Bone");
1176   RNA_def_property_pointer_sdna(prop, NULL, "act_bone");
1177   RNA_def_property_flag(prop, PROP_EDITABLE);
1178   RNA_def_property_ui_text(prop, "Active Bone", "Armature's active bone");
1179   RNA_def_property_pointer_funcs(prop, NULL, "rna_Armature_act_bone_set", NULL, NULL);
1180
1181   /* todo, redraw */
1182   /*      RNA_def_property_collection_active(prop, prop_act); */
1183 }
1184
1185 /* armature.bones.* */
1186 static void rna_def_armature_edit_bones(BlenderRNA *brna, PropertyRNA *cprop)
1187 {
1188   StructRNA *srna;
1189   PropertyRNA *prop;
1190
1191   FunctionRNA *func;
1192   PropertyRNA *parm;
1193
1194   RNA_def_property_srna(cprop, "ArmatureEditBones");
1195   srna = RNA_def_struct(brna, "ArmatureEditBones", NULL);
1196   RNA_def_struct_sdna(srna, "bArmature");
1197   RNA_def_struct_ui_text(srna, "Armature EditBones", "Collection of armature edit bones");
1198
1199   prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1200   RNA_def_property_struct_type(prop, "EditBone");
1201   RNA_def_property_pointer_sdna(prop, NULL, "act_edbone");
1202   RNA_def_property_flag(prop, PROP_EDITABLE);
1203   RNA_def_property_ui_text(prop, "Active EditBone", "Armatures active edit bone");
1204   /*RNA_def_property_update(prop, 0, "rna_Armature_act_editbone_update"); */
1205   RNA_def_property_pointer_funcs(prop, NULL, "rna_Armature_act_edit_bone_set", NULL, NULL);
1206
1207   /* todo, redraw */
1208   /*      RNA_def_property_collection_active(prop, prop_act); */
1209
1210   /* add target */
1211   func = RNA_def_function(srna, "new", "rna_Armature_edit_bone_new");
1212   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1213   RNA_def_function_ui_description(func, "Add a new bone");
1214   parm = RNA_def_string(func, "name", "Object", 0, "", "New name for the bone");
1215   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1216   /* return type */
1217   parm = RNA_def_pointer(func, "bone", "EditBone", "", "Newly created edit bone");
1218   RNA_def_function_return(func, parm);
1219
1220   /* remove target */
1221   func = RNA_def_function(srna, "remove", "rna_Armature_edit_bone_remove");
1222   RNA_def_function_flag(func, FUNC_USE_REPORTS);
1223   RNA_def_function_ui_description(func, "Remove an existing bone from the armature");
1224   /* target to remove*/
1225   parm = RNA_def_pointer(func, "bone", "EditBone", "", "EditBone to remove");
1226   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1227   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
1228 }
1229
1230 static void rna_def_armature(BlenderRNA *brna)
1231 {
1232   StructRNA *srna;
1233   PropertyRNA *prop;
1234
1235   FunctionRNA *func;
1236   PropertyRNA *parm;
1237
1238   static const EnumPropertyItem prop_drawtype_items[] = {
1239       {ARM_OCTA, "OCTAHEDRAL", 0, "Octahedral", "Display bones as octahedral shape (default)"},
1240       {ARM_LINE, "STICK", 0, "Stick", "Display bones as simple 2D lines with dots"},
1241       {ARM_B_BONE,
1242        "BBONE",
1243        0,
1244        "B-Bone",
1245        "Display bones as boxes, showing subdivision and B-Splines"},
1246       {ARM_ENVELOPE,
1247        "ENVELOPE",
1248        0,
1249        "Envelope",
1250        "Display bones as extruded spheres, showing deformation influence volume"},
1251       {ARM_WIRE,
1252        "WIRE",
1253        0,
1254        "Wire",
1255        "Display bones as thin wires, showing subdivision and B-Splines"},
1256       {0, NULL, 0, NULL, NULL},
1257   };
1258   static const EnumPropertyItem prop_pose_position_items[] = {
1259       {0, "POSE", 0, "Pose Position", "Show armature in posed state"},
1260       {ARM_RESTPOS,
1261        "REST",
1262        0,
1263        "Rest Position",
1264        "Show Armature in binding pose state (no posing possible)"},
1265       {0, NULL, 0, NULL, NULL},
1266   };
1267
1268   srna = RNA_def_struct(brna, "Armature", "ID");
1269   RNA_def_struct_ui_text(
1270       srna,
1271       "Armature",
1272       "Armature data-block containing a hierarchy of bones, usually used for rigging characters");
1273   RNA_def_struct_ui_icon(srna, ICON_ARMATURE_DATA);
1274   RNA_def_struct_sdna(srna, "bArmature");
1275
1276   func = RNA_def_function(srna, "transform", "rna_Armature_transform");
1277   RNA_def_function_flag(func, FUNC_USE_MAIN);
1278   RNA_def_function_ui_description(func, "Transform armature bones by a matrix");
1279   parm = RNA_def_float_matrix(func, "matrix", 4, 4, NULL, 0.0f, 0.0f, "", "Matrix", 0.0f, 0.0f);
1280   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
1281
1282   /* Animation Data */
1283   rna_def_animdata_common(srna);
1284
1285   /* Collections */
1286   prop = RNA_def_property(srna, "bones", PROP_COLLECTION, PROP_NONE);
1287   RNA_def_property_collection_sdna(prop, NULL, "bonebase", NULL);
1288   RNA_def_property_collection_funcs(
1289       prop, NULL, "rna_Armature_bones_next", NULL, NULL, NULL, NULL, NULL, NULL);
1290   RNA_def_property_struct_type(prop, "Bone");
1291   RNA_def_property_ui_text(prop, "Bones", "");
1292   rna_def_armature_bones(brna, prop);
1293
1294   prop = RNA_def_property(srna, "edit_bones", PROP_COLLECTION, PROP_NONE);
1295   RNA_def_property_collection_sdna(prop, NULL, "edbo", NULL);
1296   RNA_def_property_struct_type(prop, "EditBone");
1297   RNA_def_property_ui_text(prop, "Edit Bones", "");
1298   rna_def_armature_edit_bones(brna, prop);
1299
1300   /* Enum values */
1301   prop = RNA_def_property(srna, "pose_position", PROP_ENUM, PROP_NONE);
1302   RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
1303   RNA_def_property_enum_items(prop, prop_pose_position_items);
1304   RNA_def_property_ui_text(
1305       prop, "Pose Position", "Show armature in binding pose or final posed state");
1306   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
1307   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1308
1309   prop = RNA_def_property(srna, "display_type", PROP_ENUM, PROP_NONE);
1310   RNA_def_property_enum_sdna(prop, NULL, "drawtype");
1311   RNA_def_property_enum_items(prop, prop_drawtype_items);
1312   RNA_def_property_ui_text(prop, "Display Type Type", "");
1313   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1314   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1315
1316   /* Boolean values */
1317   /* layer */
1318   prop = RNA_def_property(srna, "layers", PROP_BOOLEAN, PROP_LAYER_MEMBER);
1319   RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
1320   RNA_def_property_array(prop, 32);
1321   RNA_def_property_ui_text(prop, "Visible Layers", "Armature layer visibility");
1322   RNA_def_property_boolean_funcs(prop, NULL, "rna_Armature_layer_set");
1323   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Armature_update_layers");
1324   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1325
1326   /* layer protection */
1327   prop = RNA_def_property(srna, "layers_protected", PROP_BOOLEAN, PROP_LAYER);
1328   RNA_def_property_boolean_sdna(prop, NULL, "layer_protected", 1);
1329   RNA_def_property_array(prop, 32);
1330   RNA_def_property_ui_text(prop,
1331                            "Layer Proxy Protection",
1332                            "Protected layers in Proxy Instances are restored to Proxy settings "
1333                            "on file reload and undo");
1334   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1335
1336   /* flag */
1337   prop = RNA_def_property(srna, "show_axes", PROP_BOOLEAN, PROP_NONE);
1338   RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWAXES);
1339   RNA_def_property_ui_text(prop, "Display Axes", "Display bone axes");
1340   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1341   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1342
1343   prop = RNA_def_property(srna, "show_names", PROP_BOOLEAN, PROP_NONE);
1344   RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWNAMES);
1345   RNA_def_property_ui_text(prop, "Display Names", "Display bone names");
1346   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1347   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1348
1349   prop = RNA_def_property(srna, "use_deform_delay", PROP_BOOLEAN, PROP_NONE);
1350   RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DELAYDEFORM);
1351   RNA_def_property_ui_text(
1352       prop, "Delay Deform", "Don't deform children when manipulating bones in Pose Mode");
1353   RNA_def_property_update(prop, 0, "rna_Armature_update_data");
1354
1355   prop = RNA_def_property(srna, "use_mirror_x", PROP_BOOLEAN, PROP_NONE);
1356   RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_MIRROR_EDIT);
1357   RNA_def_property_ui_text(
1358       prop, "X-Axis Mirror", "Apply changes to matching bone on opposite side of X-Axis");
1359   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1360   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1361
1362   prop = RNA_def_property(srna, "use_auto_ik", PROP_BOOLEAN, PROP_NONE);
1363   RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_AUTO_IK);
1364   RNA_def_property_ui_text(
1365       prop, "Auto IK", "Add temporary IK constraints while grabbing bones in Pose Mode");
1366   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1367   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1368
1369   prop = RNA_def_property(srna, "show_bone_custom_shapes", PROP_BOOLEAN, PROP_NONE);
1370   RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ARM_NO_CUSTOM);
1371   RNA_def_property_ui_text(
1372       prop, "Display Custom Bone Shapes", "Display bones with their custom shapes");
1373   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1374
1375   prop = RNA_def_property(srna, "show_group_colors", PROP_BOOLEAN, PROP_NONE);
1376   RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_COL_CUSTOM);
1377   RNA_def_property_ui_text(prop, "Display Bone Group Colors", "Display bone group colors");
1378   RNA_def_property_update(prop, 0, "rna_Armature_redraw_data");
1379
1380   prop = RNA_def_property(srna, "is_editmode", PROP_BOOLEAN, PROP_NONE);
1381   RNA_def_property_boolean_funcs(prop, "rna_Armature_is_editmode_get", NULL);
1382   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1383   RNA_def_property_ui_text(prop, "Is Editmode", "True when used in editmode");
1384 }
1385
1386 void RNA_def_armature(BlenderRNA *brna)
1387 {
1388   rna_def_armature(brna);
1389   rna_def_bone(brna);
1390   rna_def_edit_bone(brna);
1391 }
1392
1393 #endif