0f8f8d39c418ceed12745e6e58a0fba62be0caa4
[blender.git] / source / blender / makesrna / intern / rna_pose.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 #include <string.h>
23
24 #include "RNA_define.h"
25 #include "RNA_enum_types.h"
26
27 #include "rna_internal.h"
28
29 #include "DNA_action_types.h"
30 #include "DNA_armature_types.h"
31 #include "DNA_constraint_types.h"
32 #include "DNA_object_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "BLI_math.h"
36
37 #include "BLT_translation.h"
38
39 #include "UI_resources.h"
40
41 #include "WM_types.h"
42
43 /* Bone and Group Color Sets */
44 const EnumPropertyItem rna_enum_color_sets_items[] = {
45     {0, "DEFAULT", 0, "Default Colors", ""},
46     {1, "THEME01", ICON_COLORSET_01_VEC, "01 - Theme Color Set", ""},
47     {2, "THEME02", ICON_COLORSET_02_VEC, "02 - Theme Color Set", ""},
48     {3, "THEME03", ICON_COLORSET_03_VEC, "03 - Theme Color Set", ""},
49     {4, "THEME04", ICON_COLORSET_04_VEC, "04 - Theme Color Set", ""},
50     {5, "THEME05", ICON_COLORSET_05_VEC, "05 - Theme Color Set", ""},
51     {6, "THEME06", ICON_COLORSET_06_VEC, "06 - Theme Color Set", ""},
52     {7, "THEME07", ICON_COLORSET_07_VEC, "07 - Theme Color Set", ""},
53     {8, "THEME08", ICON_COLORSET_08_VEC, "08 - Theme Color Set", ""},
54     {9, "THEME09", ICON_COLORSET_09_VEC, "09 - Theme Color Set", ""},
55     {10, "THEME10", ICON_COLORSET_10_VEC, "10 - Theme Color Set", ""},
56     {11, "THEME11", ICON_COLORSET_11_VEC, "11 - Theme Color Set", ""},
57     {12, "THEME12", ICON_COLORSET_12_VEC, "12 - Theme Color Set", ""},
58     {13, "THEME13", ICON_COLORSET_13_VEC, "13 - Theme Color Set", ""},
59     {14, "THEME14", ICON_COLORSET_14_VEC, "14 - Theme Color Set", ""},
60     {15, "THEME15", ICON_COLORSET_15_VEC, "15 - Theme Color Set", ""},
61     {16, "THEME16", ICON_COLORSET_16_VEC, "16 - Theme Color Set", ""},
62     {17, "THEME17", ICON_COLORSET_17_VEC, "17 - Theme Color Set", ""},
63     {18, "THEME18", ICON_COLORSET_18_VEC, "18 - Theme Color Set", ""},
64     {19, "THEME19", ICON_COLORSET_19_VEC, "19 - Theme Color Set", ""},
65     {20, "THEME20", ICON_COLORSET_20_VEC, "20 - Theme Color Set", ""},
66     {-1, "CUSTOM", 0, "Custom Color Set", ""},
67     {0, NULL, 0, NULL, NULL},
68 };
69
70 #ifdef RNA_RUNTIME
71
72 #  include "BLI_ghash.h"
73 #  include "BLI_string_utils.h"
74
75 #  include "BIK_api.h"
76 #  include "BKE_action.h"
77 #  include "BKE_armature.h"
78
79 #  include "DNA_userdef_types.h"
80
81 #  include "MEM_guardedalloc.h"
82
83 #  include "BKE_context.h"
84 #  include "BKE_constraint.h"
85 #  include "BKE_global.h"
86 #  include "BKE_idprop.h"
87
88 #  include "DEG_depsgraph.h"
89 #  include "DEG_depsgraph_build.h"
90
91 #  include "ED_object.h"
92 #  include "ED_armature.h"
93
94 #  include "WM_api.h"
95
96 #  include "RNA_access.h"
97
98 static void rna_Pose_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
99 {
100   /* XXX when to use this? ob->pose->flag |= (POSE_LOCKED|POSE_DO_UNLOCK); */
101
102   DEG_id_tag_update(ptr->owner_id, ID_RECALC_GEOMETRY);
103   WM_main_add_notifier(NC_OBJECT | ND_POSE, ptr->owner_id);
104 }
105
106 static void rna_Pose_dependency_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
107 {
108   DEG_relations_tag_update(bmain);
109
110   DEG_id_tag_update(ptr->owner_id, ID_RECALC_GEOMETRY);
111   WM_main_add_notifier(NC_OBJECT | ND_POSE, ptr->owner_id);
112 }
113
114 static void rna_Pose_IK_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
115 {
116   /* XXX when to use this? ob->pose->flag |= (POSE_LOCKED|POSE_DO_UNLOCK); */
117   Object *ob = (Object *)ptr->owner_id;
118
119   DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
120   WM_main_add_notifier(NC_OBJECT | ND_POSE, ptr->owner_id);
121
122   BIK_clear_data(ob->pose);
123 }
124
125 static char *rna_Pose_path(PointerRNA *UNUSED(ptr))
126 {
127   return BLI_strdup("pose");
128 }
129
130 static char *rna_PoseBone_path(PointerRNA *ptr)
131 {
132   bPoseChannel *pchan = ptr->data;
133   char name_esc[sizeof(pchan->name) * 2];
134
135   BLI_strescape(name_esc, pchan->name, sizeof(name_esc));
136   return BLI_sprintfN("pose.bones[\"%s\"]", name_esc);
137 }
138
139 /* Bone groups only. */
140
141 static bActionGroup *rna_bone_group_new(ID *id, bPose *pose, const char *name)
142 {
143   bActionGroup *grp = BKE_pose_add_group(pose, name);
144   WM_main_add_notifier(NC_OBJECT | ND_POSE | NA_ADDED, id);
145   return grp;
146 }
147
148 static void rna_bone_group_remove(ID *id, bPose *pose, ReportList *reports, PointerRNA *grp_ptr)
149 {
150   bActionGroup *grp = grp_ptr->data;
151   const int grp_idx = BLI_findindex(&pose->agroups, grp);
152
153   if (grp_idx == -1) {
154     BKE_reportf(reports, RPT_ERROR, "Bone group '%s' not found in this object", grp->name);
155     return;
156   }
157
158   BKE_pose_remove_group(pose, grp, grp_idx + 1);
159   WM_main_add_notifier(NC_OBJECT | ND_POSE | NA_REMOVED, id);
160 }
161
162 /* shared for actions groups and bone groups */
163
164 void rna_ActionGroup_colorset_set(PointerRNA *ptr, int value)
165 {
166   bActionGroup *grp = ptr->data;
167
168   /* ensure only valid values get set */
169   if ((value >= -1) && (value < 21)) {
170     grp->customCol = value;
171
172     /* sync colors stored with theme colors based on the index specified */
173     action_group_colors_sync(grp, NULL);
174   }
175 }
176
177 bool rna_ActionGroup_is_custom_colorset_get(PointerRNA *ptr)
178 {
179   bActionGroup *grp = ptr->data;
180
181   return (grp->customCol < 0);
182 }
183
184 static void rna_BoneGroup_name_set(PointerRNA *ptr, const char *value)
185 {
186   Object *ob = (Object *)ptr->owner_id;
187   bActionGroup *agrp = ptr->data;
188
189   /* copy the new name into the name slot */
190   BLI_strncpy_utf8(agrp->name, value, sizeof(agrp->name));
191
192   BLI_uniquename(&ob->pose->agroups,
193                  agrp,
194                  CTX_DATA_(BLT_I18NCONTEXT_ID_ARMATURE, "Group"),
195                  '.',
196                  offsetof(bActionGroup, name),
197                  sizeof(agrp->name));
198 }
199
200 static IDProperty *rna_PoseBone_idprops(PointerRNA *ptr, bool create)
201 {
202   bPoseChannel *pchan = ptr->data;
203
204   if (create && !pchan->prop) {
205     IDPropertyTemplate val = {0};
206     pchan->prop = IDP_New(IDP_GROUP, &val, "RNA_PoseBone group");
207   }
208
209   return pchan->prop;
210 }
211
212 static void rna_Pose_ik_solver_set(struct PointerRNA *ptr, int value)
213 {
214   bPose *pose = (bPose *)ptr->data;
215
216   if (pose->iksolver != value) {
217     /* the solver has changed, must clean any temporary structures */
218     BIK_clear_data(pose);
219     if (pose->ikparam) {
220       MEM_freeN(pose->ikparam);
221       pose->ikparam = NULL;
222     }
223     pose->iksolver = value;
224     BKE_pose_ikparam_init(pose);
225   }
226 }
227
228 static void rna_Pose_ik_solver_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
229 {
230   Object *ob = (Object *)ptr->owner_id;
231   bPose *pose = ptr->data;
232
233   BKE_pose_tag_recalc(bmain, pose); /* checks & sorts pose channels */
234   DEG_relations_tag_update(bmain);
235
236   BKE_pose_update_constraint_flags(pose);
237
238   object_test_constraints(bmain, ob);
239
240   DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY | ID_RECALC_TRANSFORM);
241 }
242
243 /* rotation - axis-angle */
244 static void rna_PoseChannel_rotation_axis_angle_get(PointerRNA *ptr, float *value)
245 {
246   bPoseChannel *pchan = ptr->data;
247
248   /* for now, assume that rotation mode is axis-angle */
249   value[0] = pchan->rotAngle;
250   copy_v3_v3(&value[1], pchan->rotAxis);
251 }
252
253 /* rotation - axis-angle */
254 static void rna_PoseChannel_rotation_axis_angle_set(PointerRNA *ptr, const float *value)
255 {
256   bPoseChannel *pchan = ptr->data;
257
258   /* for now, assume that rotation mode is axis-angle */
259   pchan->rotAngle = value[0];
260   copy_v3_v3(pchan->rotAxis, &value[1]);
261
262   /* TODO: validate axis? */
263 }
264
265 static void rna_PoseChannel_rotation_mode_set(PointerRNA *ptr, int value)
266 {
267   bPoseChannel *pchan = ptr->data;
268
269   /* use API Method for conversions... */
270   BKE_rotMode_change_values(
271       pchan->quat, pchan->eul, pchan->rotAxis, &pchan->rotAngle, pchan->rotmode, (short)value);
272
273   /* finally, set the new rotation type */
274   pchan->rotmode = value;
275 }
276
277 static float rna_PoseChannel_length_get(PointerRNA *ptr)
278 {
279   bPoseChannel *pchan = ptr->data;
280   return len_v3v3(pchan->pose_head, pchan->pose_tail);
281 }
282
283 static void rna_PoseChannel_name_set(PointerRNA *ptr, const char *value)
284 {
285   Object *ob = (Object *)ptr->owner_id;
286   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
287   char oldname[sizeof(pchan->name)], newname[sizeof(pchan->name)];
288
289   /* need to be on the stack */
290   BLI_strncpy_utf8(newname, value, sizeof(pchan->name));
291   BLI_strncpy(oldname, pchan->name, sizeof(pchan->name));
292
293   BLI_assert(BKE_id_is_in_global_main(&ob->id));
294   BLI_assert(BKE_id_is_in_global_main(ob->data));
295   ED_armature_bone_rename(G_MAIN, ob->data, oldname, newname);
296 }
297
298 static PointerRNA rna_PoseChannel_bone_get(PointerRNA *ptr)
299 {
300   Object *ob = (Object *)ptr->owner_id;
301   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
302   PointerRNA tmp_ptr = *ptr;
303
304   /* Replace the id_data pointer with the Armature ID. */
305   tmp_ptr.owner_id = ob->data;
306
307   return rna_pointer_inherit_refine(&tmp_ptr, &RNA_Bone, pchan->bone);
308 }
309
310 static bool rna_PoseChannel_has_ik_get(PointerRNA *ptr)
311 {
312   Object *ob = (Object *)ptr->owner_id;
313   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
314
315   return BKE_pose_channel_in_IK_chain(ob, pchan);
316 }
317
318 static StructRNA *rna_IKParam_refine(PointerRNA *ptr)
319 {
320   bIKParam *param = (bIKParam *)ptr->data;
321
322   switch (param->iksolver) {
323     case IKSOLVER_ITASC:
324       return &RNA_Itasc;
325     default:
326       return &RNA_IKParam;
327   }
328 }
329
330 static PointerRNA rna_Pose_ikparam_get(struct PointerRNA *ptr)
331 {
332   bPose *pose = (bPose *)ptr->data;
333   return rna_pointer_inherit_refine(ptr, &RNA_IKParam, pose->ikparam);
334 }
335
336 static StructRNA *rna_Pose_ikparam_typef(PointerRNA *ptr)
337 {
338   bPose *pose = (bPose *)ptr->data;
339
340   switch (pose->iksolver) {
341     case IKSOLVER_ITASC:
342       return &RNA_Itasc;
343     default:
344       return &RNA_IKParam;
345   }
346 }
347
348 static void rna_Itasc_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
349 {
350   Object *ob = (Object *)ptr->owner_id;
351   bItasc *itasc = ptr->data;
352
353   /* verify values */
354   if (itasc->precision < 0.0001f) {
355     itasc->precision = 0.0001f;
356   }
357   if (itasc->minstep < 0.001f) {
358     itasc->minstep = 0.001f;
359   }
360   if (itasc->maxstep < itasc->minstep) {
361     itasc->maxstep = itasc->minstep;
362   }
363   if (itasc->feedback < 0.01f) {
364     itasc->feedback = 0.01f;
365   }
366   if (itasc->feedback > 100.f) {
367     itasc->feedback = 100.f;
368   }
369   if (itasc->maxvel < 0.01f) {
370     itasc->maxvel = 0.01f;
371   }
372   if (itasc->maxvel > 100.f) {
373     itasc->maxvel = 100.f;
374   }
375   BIK_update_param(ob->pose);
376
377   DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY);
378 }
379
380 static void rna_Itasc_update_rebuild(Main *bmain, Scene *scene, PointerRNA *ptr)
381 {
382   Object *ob = (Object *)ptr->owner_id;
383   bPose *pose = ob->pose;
384
385   BKE_pose_tag_recalc(bmain, pose); /* checks & sorts pose channels */
386   rna_Itasc_update(bmain, scene, ptr);
387 }
388
389 static void rna_PoseChannel_bone_custom_set(PointerRNA *ptr,
390                                             PointerRNA value,
391                                             struct ReportList *UNUSED(reports))
392 {
393   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
394
395   if (pchan->custom) {
396     id_us_min(&pchan->custom->id);
397     pchan->custom = NULL;
398   }
399
400   pchan->custom = value.data;
401
402   id_us_plus(&pchan->custom->id);
403 }
404
405 static PointerRNA rna_PoseChannel_bone_group_get(PointerRNA *ptr)
406 {
407   Object *ob = (Object *)ptr->owner_id;
408   bPose *pose = (ob) ? ob->pose : NULL;
409   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
410   bActionGroup *grp;
411
412   if (pose) {
413     grp = BLI_findlink(&pose->agroups, pchan->agrp_index - 1);
414   }
415   else {
416     grp = NULL;
417   }
418
419   return rna_pointer_inherit_refine(ptr, &RNA_BoneGroup, grp);
420 }
421
422 static void rna_PoseChannel_bone_group_set(PointerRNA *ptr,
423                                            PointerRNA value,
424                                            struct ReportList *UNUSED(reports))
425 {
426   Object *ob = (Object *)ptr->owner_id;
427   bPose *pose = (ob) ? ob->pose : NULL;
428   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
429
430   if (pose) {
431     pchan->agrp_index = BLI_findindex(&pose->agroups, value.data) + 1;
432   }
433   else {
434     pchan->agrp_index = 0;
435   }
436 }
437
438 static int rna_PoseChannel_bone_group_index_get(PointerRNA *ptr)
439 {
440   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
441   return MAX2(pchan->agrp_index - 1, 0);
442 }
443
444 static void rna_PoseChannel_bone_group_index_set(PointerRNA *ptr, int value)
445 {
446   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
447   pchan->agrp_index = value + 1;
448 }
449
450 static void rna_PoseChannel_bone_group_index_range(
451     PointerRNA *ptr, int *min, int *max, int *UNUSED(softmin), int *UNUSED(softmax))
452 {
453   Object *ob = (Object *)ptr->owner_id;
454   bPose *pose = (ob) ? ob->pose : NULL;
455
456   *min = 0;
457   *max = pose ? max_ii(0, BLI_listbase_count(&pose->agroups) - 1) : 0;
458 }
459
460 static PointerRNA rna_Pose_active_bone_group_get(PointerRNA *ptr)
461 {
462   bPose *pose = (bPose *)ptr->data;
463   return rna_pointer_inherit_refine(
464       ptr, &RNA_BoneGroup, BLI_findlink(&pose->agroups, pose->active_group - 1));
465 }
466
467 static void rna_Pose_active_bone_group_set(PointerRNA *ptr,
468                                            PointerRNA value,
469                                            struct ReportList *UNUSED(reports))
470 {
471   bPose *pose = (bPose *)ptr->data;
472   pose->active_group = BLI_findindex(&pose->agroups, value.data) + 1;
473 }
474
475 static int rna_Pose_active_bone_group_index_get(PointerRNA *ptr)
476 {
477   bPose *pose = (bPose *)ptr->data;
478   return MAX2(pose->active_group - 1, 0);
479 }
480
481 static void rna_Pose_active_bone_group_index_set(PointerRNA *ptr, int value)
482 {
483   bPose *pose = (bPose *)ptr->data;
484   pose->active_group = value + 1;
485 }
486
487 static void rna_Pose_active_bone_group_index_range(
488     PointerRNA *ptr, int *min, int *max, int *UNUSED(softmin), int *UNUSED(softmax))
489 {
490   bPose *pose = (bPose *)ptr->data;
491
492   *min = 0;
493   *max = max_ii(0, BLI_listbase_count(&pose->agroups) - 1);
494 }
495
496 #  if 0
497 static void rna_pose_bgroup_name_index_get(PointerRNA *ptr, char *value, int index)
498 {
499   bPose *pose = (bPose *)ptr->data;
500   bActionGroup *grp;
501
502   grp = BLI_findlink(&pose->agroups, index - 1);
503
504   if (grp) {
505     BLI_strncpy(value, grp->name, sizeof(grp->name));
506   }
507   else {
508     value[0] = '\0';
509   }
510 }
511
512 static int rna_pose_bgroup_name_index_length(PointerRNA *ptr, int index)
513 {
514   bPose *pose = (bPose *)ptr->data;
515   bActionGroup *grp;
516
517   grp = BLI_findlink(&pose->agroups, index - 1);
518   return (grp) ? strlen(grp->name) : 0;
519 }
520
521 static void rna_pose_bgroup_name_index_set(PointerRNA *ptr, const char *value, short *index)
522 {
523   bPose *pose = (bPose *)ptr->data;
524   bActionGroup *grp;
525   int a;
526
527   for (a = 1, grp = pose->agroups.first; grp; grp = grp->next, a++) {
528     if (STREQ(grp->name, value)) {
529       *index = a;
530       return;
531     }
532   }
533
534   *index = 0;
535 }
536
537 static void rna_pose_pgroup_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
538 {
539   bPose *pose = (bPose *)ptr->data;
540   bActionGroup *grp;
541
542   for (grp = pose->agroups.first; grp; grp = grp->next) {
543     if (STREQ(grp->name, value)) {
544       BLI_strncpy(result, value, maxlen);
545       return;
546     }
547   }
548
549   result[0] = '\0';
550 }
551 #  endif
552
553 static PointerRNA rna_PoseChannel_active_constraint_get(PointerRNA *ptr)
554 {
555   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
556   bConstraint *con = BKE_constraints_active_get(&pchan->constraints);
557   return rna_pointer_inherit_refine(ptr, &RNA_Constraint, con);
558 }
559
560 static void rna_PoseChannel_active_constraint_set(PointerRNA *ptr,
561                                                   PointerRNA value,
562                                                   struct ReportList *UNUSED(reports))
563 {
564   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
565   BKE_constraints_active_set(&pchan->constraints, (bConstraint *)value.data);
566 }
567
568 static bConstraint *rna_PoseChannel_constraints_new(ID *id,
569                                                     bPoseChannel *pchan,
570                                                     Main *main,
571                                                     int type)
572 {
573   Object *ob = (Object *)id;
574   bConstraint *new_con = BKE_constraint_add_for_pose(ob, pchan, NULL, type);
575
576   ED_object_constraint_dependency_tag_update(main, ob, new_con);
577   WM_main_add_notifier(NC_OBJECT | ND_CONSTRAINT | NA_ADDED, id);
578
579   return new_con;
580 }
581
582 static void rna_PoseChannel_constraints_remove(
583     ID *id, bPoseChannel *pchan, Main *bmain, ReportList *reports, PointerRNA *con_ptr)
584 {
585   bConstraint *con = con_ptr->data;
586   const bool is_ik = ELEM(con->type, CONSTRAINT_TYPE_KINEMATIC, CONSTRAINT_TYPE_SPLINEIK);
587   Object *ob = (Object *)id;
588
589   if (BLI_findindex(&pchan->constraints, con) == -1) {
590     BKE_reportf(
591         reports, RPT_ERROR, "Constraint '%s' not found in pose bone '%s'", con->name, pchan->name);
592     return;
593   }
594
595   BKE_constraint_remove(&pchan->constraints, con);
596   RNA_POINTER_INVALIDATE(con_ptr);
597
598   ED_object_constraint_update(bmain, ob);
599
600   BKE_constraints_active_set(&pchan->constraints,
601                              NULL); /* XXX, is this really needed? - Campbell */
602
603   WM_main_add_notifier(NC_OBJECT | ND_CONSTRAINT | NA_REMOVED, id);
604
605   if (is_ik) {
606     BIK_clear_data(ob->pose);
607   }
608 }
609
610 static void rna_PoseChannel_constraints_move(
611     ID *id, bPoseChannel *pchan, Main *bmain, ReportList *reports, int from, int to)
612 {
613   Object *ob = (Object *)id;
614
615   if (from == to) {
616     return;
617   }
618
619   if (!BLI_listbase_move_index(&pchan->constraints, from, to)) {
620     BKE_reportf(reports, RPT_ERROR, "Could not move constraint from index '%d' to '%d'", from, to);
621     return;
622   }
623
624   ED_object_constraint_tag_update(bmain, ob, NULL);
625   WM_main_add_notifier(NC_OBJECT | ND_CONSTRAINT, ob);
626 }
627
628 bool rna_PoseChannel_constraints_override_apply(Main *UNUSED(bmain),
629                                                 PointerRNA *ptr_dst,
630                                                 PointerRNA *ptr_src,
631                                                 PointerRNA *UNUSED(ptr_storage),
632                                                 PropertyRNA *UNUSED(prop_dst),
633                                                 PropertyRNA *UNUSED(prop_src),
634                                                 PropertyRNA *UNUSED(prop_storage),
635                                                 const int UNUSED(len_dst),
636                                                 const int UNUSED(len_src),
637                                                 const int UNUSED(len_storage),
638                                                 PointerRNA *UNUSED(ptr_item_dst),
639                                                 PointerRNA *UNUSED(ptr_item_src),
640                                                 PointerRNA *UNUSED(ptr_item_storage),
641                                                 IDOverrideLibraryPropertyOperation *opop)
642 {
643   BLI_assert(opop->operation == IDOVERRIDE_LIBRARY_OP_INSERT_AFTER &&
644              "Unsupported RNA override operation on constraints collection");
645
646   bPoseChannel *pchan_dst = (bPoseChannel *)ptr_dst->data;
647   bPoseChannel *pchan_src = (bPoseChannel *)ptr_src->data;
648
649   /* Remember that insertion operations are defined and stored in correct order, which means that
650    * even if we insert several items in a row, we always insert first one, then second one, etc.
651    * So we should always find 'anchor' constraint in both _src *and* _dst> */
652   bConstraint *con_anchor = NULL;
653   if (opop->subitem_local_name && opop->subitem_local_name[0]) {
654     con_anchor = BLI_findstring(
655         &pchan_dst->constraints, opop->subitem_local_name, offsetof(bConstraint, name));
656   }
657   if (con_anchor == NULL && opop->subitem_local_index >= 0) {
658     con_anchor = BLI_findlink(&pchan_dst->constraints, opop->subitem_local_index);
659   }
660   /* Otherwise we just insert in first position. */
661
662   bConstraint *con_src = NULL;
663   if (opop->subitem_local_name && opop->subitem_local_name[0]) {
664     con_src = BLI_findstring(
665         &pchan_src->constraints, opop->subitem_local_name, offsetof(bConstraint, name));
666   }
667   if (con_src == NULL && opop->subitem_local_index >= 0) {
668     con_src = BLI_findlink(&pchan_src->constraints, opop->subitem_local_index);
669   }
670   con_src = con_src ? con_src->next : pchan_src->constraints.first;
671
672   BLI_assert(con_src != NULL);
673
674   bConstraint *con_dst = BKE_constraint_duplicate_ex(con_src, 0, true);
675
676   /* This handles NULL anchor as expected by adding at head of list. */
677   BLI_insertlinkafter(&pchan_dst->constraints, con_anchor, con_dst);
678
679   /* This should actually *not* be needed in typical cases.
680    * However, if overridden source was edited,
681    * we *may* have some new conflicting names. */
682   BKE_constraint_unique_name(con_dst, &pchan_dst->constraints);
683
684   //  printf("%s: We inserted a constraint...\n", __func__);
685   return true;
686 }
687
688 static int rna_PoseChannel_proxy_editable(PointerRNA *ptr, const char **r_info)
689 {
690   Object *ob = (Object *)ptr->owner_id;
691   bArmature *arm = ob->data;
692   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
693
694   if (ob->proxy && pchan->bone && (pchan->bone->layer & arm->layer_protected)) {
695     *r_info = "Can't edit property of a proxy on a protected layer";
696     return 0;
697   }
698
699   return PROP_EDITABLE;
700 }
701
702 static int rna_PoseChannel_location_editable(PointerRNA *ptr, int index)
703 {
704   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
705
706   /* only if the axis in question is locked, not editable... */
707   if ((index == 0) && (pchan->protectflag & OB_LOCK_LOCX)) {
708     return 0;
709   }
710   else if ((index == 1) && (pchan->protectflag & OB_LOCK_LOCY)) {
711     return 0;
712   }
713   else if ((index == 2) && (pchan->protectflag & OB_LOCK_LOCZ)) {
714     return 0;
715   }
716   else {
717     return PROP_EDITABLE;
718   }
719 }
720
721 static int rna_PoseChannel_scale_editable(PointerRNA *ptr, int index)
722 {
723   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
724
725   /* only if the axis in question is locked, not editable... */
726   if ((index == 0) && (pchan->protectflag & OB_LOCK_SCALEX)) {
727     return 0;
728   }
729   else if ((index == 1) && (pchan->protectflag & OB_LOCK_SCALEY)) {
730     return 0;
731   }
732   else if ((index == 2) && (pchan->protectflag & OB_LOCK_SCALEZ)) {
733     return 0;
734   }
735   else {
736     return PROP_EDITABLE;
737   }
738 }
739
740 static int rna_PoseChannel_rotation_euler_editable(PointerRNA *ptr, int index)
741 {
742   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
743
744   /* only if the axis in question is locked, not editable... */
745   if ((index == 0) && (pchan->protectflag & OB_LOCK_ROTX)) {
746     return 0;
747   }
748   else if ((index == 1) && (pchan->protectflag & OB_LOCK_ROTY)) {
749     return 0;
750   }
751   else if ((index == 2) && (pchan->protectflag & OB_LOCK_ROTZ)) {
752     return 0;
753   }
754   else {
755     return PROP_EDITABLE;
756   }
757 }
758
759 static int rna_PoseChannel_rotation_4d_editable(PointerRNA *ptr, int index)
760 {
761   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
762
763   /* only consider locks if locking components individually... */
764   if (pchan->protectflag & OB_LOCK_ROT4D) {
765     /* only if the axis in question is locked, not editable... */
766     if ((index == 0) && (pchan->protectflag & OB_LOCK_ROTW)) {
767       return 0;
768     }
769     else if ((index == 1) && (pchan->protectflag & OB_LOCK_ROTX)) {
770       return 0;
771     }
772     else if ((index == 2) && (pchan->protectflag & OB_LOCK_ROTY)) {
773       return 0;
774     }
775     else if ((index == 3) && (pchan->protectflag & OB_LOCK_ROTZ)) {
776       return 0;
777     }
778   }
779
780   return PROP_EDITABLE;
781 }
782
783 /* not essential, but much faster then the default lookup function */
784 static int rna_PoseBones_lookup_string(PointerRNA *ptr, const char *key, PointerRNA *r_ptr)
785 {
786   bPose *pose = (bPose *)ptr->data;
787   bPoseChannel *pchan = BKE_pose_channel_find_name(pose, key);
788   if (pchan) {
789     RNA_pointer_create(ptr->owner_id, &RNA_PoseBone, pchan, r_ptr);
790     return true;
791   }
792   else {
793     return false;
794   }
795 }
796
797 static void rna_PoseChannel_matrix_basis_get(PointerRNA *ptr, float *values)
798 {
799   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
800   BKE_pchan_to_mat4(pchan, (float(*)[4])values);
801 }
802
803 static void rna_PoseChannel_matrix_basis_set(PointerRNA *ptr, const float *values)
804 {
805   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
806   BKE_pchan_apply_mat4(pchan, (float(*)[4])values, false); /* no compat for predictable result */
807 }
808
809 static void rna_PoseChannel_matrix_set(PointerRNA *ptr, const float *values)
810 {
811   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
812   Object *ob = (Object *)ptr->owner_id;
813   float tmat[4][4];
814
815   BKE_armature_mat_pose_to_bone_ex(NULL, ob, pchan, (float(*)[4])values, tmat);
816
817   BKE_pchan_apply_mat4(pchan, tmat, false); /* no compat for predictable result */
818 }
819
820 static bPoseChannel *rna_PoseChannel_ensure_own_pchan(Object *ob,
821                                                       Object *ref_ob,
822                                                       bPoseChannel *ref_pchan)
823 {
824   if (ref_ob != ob) {
825     /* We are trying to set a pchan from another object! Forbidden,
826      * try to find by name, or abort. */
827     if (ref_pchan != NULL) {
828       ref_pchan = BKE_pose_channel_find_name(ob->pose, ref_pchan->name);
829     }
830   }
831   return ref_pchan;
832 }
833
834 static void rna_PoseChannel_custom_shape_transform_set(PointerRNA *ptr,
835                                                        PointerRNA value,
836                                                        struct ReportList *UNUSED(reports))
837 {
838   bPoseChannel *pchan = (bPoseChannel *)ptr->data;
839   Object *ob = (Object *)ptr->owner_id;
840
841   pchan->custom_tx = rna_PoseChannel_ensure_own_pchan(ob, (Object *)value.owner_id, value.data);
842 }
843
844 #else
845
846 /* common properties for Action/Bone Groups - related to color */
847 void rna_def_actionbone_group_common(StructRNA *srna, int update_flag, const char *update_cb)
848 {
849   PropertyRNA *prop;
850
851   /* color set + colors */
852   prop = RNA_def_property(srna, "color_set", PROP_ENUM, PROP_NONE);
853   RNA_def_property_enum_sdna(prop, NULL, "customCol");
854   RNA_def_property_enum_items(prop, rna_enum_color_sets_items);
855   RNA_def_property_enum_funcs(prop, NULL, "rna_ActionGroup_colorset_set", NULL);
856   RNA_def_property_ui_text(prop, "Color Set", "Custom color set to use");
857   RNA_def_property_update(prop, update_flag, update_cb);
858
859   prop = RNA_def_property(srna, "is_custom_color_set", PROP_BOOLEAN, PROP_NONE);
860   RNA_def_property_boolean_funcs(prop, "rna_ActionGroup_is_custom_colorset_get", NULL);
861   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
862   RNA_def_property_ui_text(
863       prop, "Custom Color Set", "Color set is user-defined instead of a fixed theme color set");
864
865   /* TODO: editing the colors for this should result in changes to the color type... */
866   prop = RNA_def_property(srna, "colors", PROP_POINTER, PROP_NONE);
867   RNA_def_property_flag(prop, PROP_NEVER_NULL);
868   RNA_def_property_struct_type(prop, "ThemeBoneColorSet");
869   /* NOTE: the DNA data is not really a pointer, but this code works :) */
870   RNA_def_property_pointer_sdna(prop, NULL, "cs");
871   RNA_def_property_ui_text(
872       prop, "Colors", "Copy of the colors associated with the group's color set");
873   RNA_def_property_update(prop, update_flag, update_cb);
874 }
875
876 static void rna_def_bone_group(BlenderRNA *brna)
877 {
878   StructRNA *srna;
879   PropertyRNA *prop;
880
881   /* struct */
882   srna = RNA_def_struct(brna, "BoneGroup", NULL);
883   RNA_def_struct_sdna(srna, "bActionGroup");
884   RNA_def_struct_ui_text(srna, "Bone Group", "Groups of Pose Channels (Bones)");
885   RNA_def_struct_ui_icon(srna, ICON_GROUP_BONE);
886
887   /* name */
888   prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
889   RNA_def_property_ui_text(prop, "Name", "");
890   RNA_def_property_string_funcs(prop, NULL, NULL, "rna_BoneGroup_name_set");
891   RNA_def_struct_name_property(srna, prop);
892
893   /* TODO: add some runtime-collections stuff to access grouped bones  */
894
895   /* color set */
896   rna_def_actionbone_group_common(srna, NC_OBJECT | ND_POSE, "rna_Pose_update");
897 }
898
899 static const EnumPropertyItem prop_iksolver_items[] = {
900     {IKSOLVER_STANDARD, "LEGACY", 0, "Standard", "Original IK solver"},
901     {IKSOLVER_ITASC, "ITASC", 0, "iTaSC", "Multi constraint, stateful IK solver"},
902     {0, NULL, 0, NULL, NULL},
903 };
904
905 static const EnumPropertyItem prop_solver_items[] = {
906     {ITASC_SOLVER_SDLS, "SDLS", 0, "SDLS", "Selective Damped Least Square"},
907     {ITASC_SOLVER_DLS, "DLS", 0, "DLS", "Damped Least Square with Numerical Filtering"},
908     {0, NULL, 0, NULL, NULL},
909 };
910
911 static void rna_def_pose_channel_constraints(BlenderRNA *brna, PropertyRNA *cprop)
912 {
913   StructRNA *srna;
914   PropertyRNA *prop;
915
916   FunctionRNA *func;
917   PropertyRNA *parm;
918
919   RNA_def_property_srna(cprop, "PoseBoneConstraints");
920   srna = RNA_def_struct(brna, "PoseBoneConstraints", NULL);
921   RNA_def_struct_sdna(srna, "bPoseChannel");
922   RNA_def_struct_ui_text(srna, "PoseBone Constraints", "Collection of pose bone constraints");
923
924   /* Collection active property */
925   prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
926   RNA_def_property_struct_type(prop, "Constraint");
927   RNA_def_property_pointer_funcs(prop,
928                                  "rna_PoseChannel_active_constraint_get",
929                                  "rna_PoseChannel_active_constraint_set",
930                                  NULL,
931                                  NULL);
932   RNA_def_property_flag(prop, PROP_EDITABLE);
933   RNA_def_property_ui_text(prop, "Active Constraint", "Active PoseChannel constraint");
934
935   /* Constraint collection */
936   func = RNA_def_function(srna, "new", "rna_PoseChannel_constraints_new");
937   RNA_def_function_ui_description(func, "Add a constraint to this object");
938   RNA_def_function_flag(func,
939                         FUNC_USE_MAIN | FUNC_USE_SELF_ID); /* ID and Main needed for refresh */
940   /* return type */
941   parm = RNA_def_pointer(func, "constraint", "Constraint", "", "New constraint");
942   RNA_def_function_return(func, parm);
943   /* constraint to add */
944   parm = RNA_def_enum(
945       func, "type", rna_enum_constraint_type_items, 1, "", "Constraint type to add");
946   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
947
948   func = RNA_def_function(srna, "remove", "rna_PoseChannel_constraints_remove");
949   RNA_def_function_ui_description(func, "Remove a constraint from this object");
950   RNA_def_function_flag(
951       func, FUNC_USE_SELF_ID | FUNC_USE_MAIN | FUNC_USE_REPORTS); /* ID needed for refresh */
952   /* constraint to remove */
953   parm = RNA_def_pointer(func, "constraint", "Constraint", "", "Removed constraint");
954   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
955   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
956
957   func = RNA_def_function(srna, "move", "rna_PoseChannel_constraints_move");
958   RNA_def_function_ui_description(func, "Move a constraint to a different position");
959   RNA_def_function_flag(func, FUNC_USE_SELF_ID | FUNC_USE_MAIN | FUNC_USE_REPORTS);
960   parm = RNA_def_int(
961       func, "from_index", -1, INT_MIN, INT_MAX, "From Index", "Index to move", 0, 10000);
962   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
963   parm = RNA_def_int(func, "to_index", -1, INT_MIN, INT_MAX, "To Index", "Target index", 0, 10000);
964   RNA_def_parameter_flags(parm, 0, PARM_REQUIRED);
965 }
966
967 static void rna_def_pose_channel(BlenderRNA *brna)
968 {
969   StructRNA *srna;
970   PropertyRNA *prop;
971
972   srna = RNA_def_struct(brna, "PoseBone", NULL);
973   RNA_def_struct_sdna(srna, "bPoseChannel");
974   RNA_def_struct_ui_text(srna, "Pose Bone", "Channel defining pose data for a bone in a Pose");
975   RNA_def_struct_path_func(srna, "rna_PoseBone_path");
976   RNA_def_struct_idprops_func(srna, "rna_PoseBone_idprops");
977   RNA_def_struct_ui_icon(srna, ICON_BONE_DATA);
978
979   /* Bone Constraints */
980   prop = RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
981   RNA_def_property_struct_type(prop, "Constraint");
982   RNA_def_property_override_flag(
983       prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY | PROPOVERRIDE_LIBRARY_INSERTION);
984   RNA_def_property_ui_text(prop, "Constraints", "Constraints that act on this PoseChannel");
985   RNA_def_property_override_funcs(prop, NULL, NULL, "rna_PoseChannel_constraints_override_apply");
986
987   rna_def_pose_channel_constraints(brna, prop);
988
989   /* Name + Selection Status */
990   prop = RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
991   RNA_def_property_string_funcs(prop, NULL, NULL, "rna_PoseChannel_name_set");
992   RNA_def_property_ui_text(prop, "Name", "");
993   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
994   RNA_def_struct_name_property(srna, prop);
995
996   /* Baked Bone Path cache data */
997   rna_def_motionpath_common(srna);
998
999   /* Relationships to other bones */
1000   prop = RNA_def_property(srna, "bone", PROP_POINTER, PROP_NONE);
1001   RNA_def_property_flag(prop, PROP_NEVER_NULL);
1002   RNA_def_property_struct_type(prop, "Bone");
1003   RNA_def_property_pointer_funcs(prop, "rna_PoseChannel_bone_get", NULL, NULL, NULL);
1004   RNA_def_property_flag(prop, PROP_PTR_NO_OWNERSHIP);
1005   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1006   RNA_def_property_ui_text(prop, "Bone", "Bone associated with this PoseBone");
1007
1008   prop = RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
1009   RNA_def_property_struct_type(prop, "PoseBone");
1010   RNA_def_property_flag(prop, PROP_PTR_NO_OWNERSHIP);
1011   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1012   RNA_def_property_ui_text(prop, "Parent", "Parent of this pose bone");
1013
1014   prop = RNA_def_property(srna, "child", PROP_POINTER, PROP_NONE);
1015   RNA_def_property_struct_type(prop, "PoseBone");
1016   RNA_def_property_flag(prop, PROP_PTR_NO_OWNERSHIP);
1017   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1018   RNA_def_property_ui_text(prop, "Child", "Child of this pose bone");
1019
1020   /* Transformation settings */
1021   prop = RNA_def_property(srna, "location", PROP_FLOAT, PROP_TRANSLATION);
1022   RNA_def_property_float_sdna(prop, NULL, "loc");
1023   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
1024   RNA_def_property_editable_array_func(prop, "rna_PoseChannel_location_editable");
1025   RNA_def_property_ui_text(prop, "Location", "");
1026   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
1027   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1028
1029   prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);
1030   RNA_def_property_float_sdna(prop, NULL, "size");
1031   RNA_def_property_flag(prop, PROP_PROPORTIONAL);
1032   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
1033   RNA_def_property_editable_array_func(prop, "rna_PoseChannel_scale_editable");
1034   RNA_def_property_float_array_default(prop, rna_default_scale_3d);
1035   RNA_def_property_ui_text(prop, "Scale", "");
1036   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1037
1038   prop = RNA_def_property(srna, "rotation_quaternion", PROP_FLOAT, PROP_QUATERNION);
1039   RNA_def_property_float_sdna(prop, NULL, "quat");
1040   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
1041   RNA_def_property_editable_array_func(prop, "rna_PoseChannel_rotation_4d_editable");
1042   RNA_def_property_float_array_default(prop, rna_default_quaternion);
1043   RNA_def_property_ui_text(prop, "Quaternion Rotation", "Rotation in Quaternions");
1044   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1045
1046   /* XXX: for axis-angle, it would have been nice to have 2 separate fields for UI purposes, but
1047    * having a single one is better for Keyframing and other property-management situations...
1048    */
1049   prop = RNA_def_property(srna, "rotation_axis_angle", PROP_FLOAT, PROP_AXISANGLE);
1050   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
1051   RNA_def_property_array(prop, 4);
1052   RNA_def_property_float_funcs(prop,
1053                                "rna_PoseChannel_rotation_axis_angle_get",
1054                                "rna_PoseChannel_rotation_axis_angle_set",
1055                                NULL);
1056   RNA_def_property_editable_array_func(prop, "rna_PoseChannel_rotation_4d_editable");
1057   RNA_def_property_float_array_default(prop, rna_default_axis_angle);
1058   RNA_def_property_ui_text(
1059       prop, "Axis-Angle Rotation", "Angle of Rotation for Axis-Angle rotation representation");
1060   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1061
1062   prop = RNA_def_property(srna, "rotation_euler", PROP_FLOAT, PROP_EULER);
1063   RNA_def_property_float_sdna(prop, NULL, "eul");
1064   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
1065   RNA_def_property_editable_array_func(prop, "rna_PoseChannel_rotation_euler_editable");
1066   RNA_def_property_ui_text(prop, "Euler Rotation", "Rotation in Eulers");
1067   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1068
1069   prop = RNA_def_property(srna, "rotation_mode", PROP_ENUM, PROP_NONE);
1070   RNA_def_property_enum_sdna(prop, NULL, "rotmode");
1071   RNA_def_property_enum_items(prop, rna_enum_object_rotation_mode_items);
1072   RNA_def_property_enum_funcs(prop, NULL, "rna_PoseChannel_rotation_mode_set", NULL);
1073   /* XXX... disabled, since proxy-locked layers are currently
1074    * used for ensuring proxy-syncing too */
1075   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1076   RNA_def_property_ui_text(prop, "Rotation Mode", "");
1077   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1078
1079   /* Curved bones settings - Applied on top of restpose values */
1080   rna_def_bone_curved_common(srna, true, false);
1081
1082   /* Custom BBone next/prev sources */
1083   prop = RNA_def_property(srna, "bbone_custom_handle_start", PROP_POINTER, PROP_NONE);
1084   RNA_def_property_pointer_sdna(prop, NULL, "bbone_prev");
1085   RNA_def_property_struct_type(prop, "PoseBone");
1086   RNA_def_property_flag(prop, PROP_PTR_NO_OWNERSHIP);
1087   RNA_def_property_override_flag(prop, PROPOVERRIDE_NO_COMPARISON);
1088   RNA_def_property_ui_text(
1089       prop, "B-Bone Start Handle", "Bone that serves as the start handle for the B-Bone curve");
1090   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_dependency_update");
1091
1092   prop = RNA_def_property(srna, "bbone_custom_handle_end", PROP_POINTER, PROP_NONE);
1093   RNA_def_property_pointer_sdna(prop, NULL, "bbone_next");
1094   RNA_def_property_struct_type(prop, "PoseBone");
1095   RNA_def_property_flag(prop, PROP_PTR_NO_OWNERSHIP);
1096   RNA_def_property_override_flag(prop, PROPOVERRIDE_NO_COMPARISON);
1097   RNA_def_property_ui_text(
1098       prop, "B-Bone End Handle", "Bone that serves as the end handle for the B-Bone curve");
1099   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_dependency_update");
1100
1101   /* transform matrices - should be read-only since these are set directly by AnimSys evaluation */
1102   prop = RNA_def_property(srna, "matrix_channel", PROP_FLOAT, PROP_MATRIX);
1103   RNA_def_property_float_sdna(prop, NULL, "chan_mat");
1104   RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
1105   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1106   RNA_def_property_ui_text(prop, "Channel Matrix", "4x4 matrix, before constraints");
1107
1108   /* writable because it touches loc/scale/rot directly */
1109   prop = RNA_def_property(srna, "matrix_basis", PROP_FLOAT, PROP_MATRIX);
1110   RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
1111   RNA_def_property_ui_text(
1112       prop,
1113       "Basis Matrix",
1114       "Alternative access to location/scale/rotation relative to the parent and own rest bone");
1115   RNA_def_property_float_funcs(
1116       prop, "rna_PoseChannel_matrix_basis_get", "rna_PoseChannel_matrix_basis_set", NULL);
1117   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1118   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1119
1120   /* final matrix */
1121   prop = RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
1122   RNA_def_property_float_sdna(prop, NULL, "pose_mat");
1123   RNA_def_property_multi_array(prop, 2, rna_matrix_dimsize_4x4);
1124   RNA_def_property_float_funcs(prop, NULL, "rna_PoseChannel_matrix_set", NULL);
1125   RNA_def_property_ui_text(
1126       prop,
1127       "Pose Matrix",
1128       "Final 4x4 matrix after constraints and drivers are applied (object space)");
1129   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1130
1131   /* Head/Tail Coordinates (in Pose Space) - Automatically calculated... */
1132   prop = RNA_def_property(srna, "head", PROP_FLOAT, PROP_TRANSLATION);
1133   RNA_def_property_float_sdna(prop, NULL, "pose_head");
1134   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1135   RNA_def_property_ui_text(prop, "Pose Head Position", "Location of head of the channel's bone");
1136   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
1137
1138   prop = RNA_def_property(srna, "tail", PROP_FLOAT, PROP_TRANSLATION);
1139   RNA_def_property_float_sdna(prop, NULL, "pose_tail");
1140   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1141   RNA_def_property_ui_text(prop, "Pose Tail Position", "Location of tail of the channel's bone");
1142   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 1, RNA_TRANSLATION_PREC_DEFAULT);
1143
1144   prop = RNA_def_property(srna, "length", PROP_FLOAT, PROP_DISTANCE);
1145   RNA_def_property_float_funcs(prop, "rna_PoseChannel_length_get", NULL, NULL);
1146   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1147   RNA_def_property_ui_text(prop, "Length", "Length of the bone");
1148
1149   /* IK Settings */
1150   prop = RNA_def_property(srna, "is_in_ik_chain", PROP_BOOLEAN, PROP_NONE);
1151   RNA_def_property_boolean_funcs(prop, "rna_PoseChannel_has_ik_get", NULL);
1152   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1153   RNA_def_property_ui_text(prop, "Has IK", "Is part of an IK chain");
1154   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1155
1156   prop = RNA_def_property(srna, "lock_ik_x", PROP_BOOLEAN, PROP_NONE);
1157   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_XDOF);
1158   RNA_def_property_ui_icon(prop, ICON_UNLOCKED, true);
1159   RNA_def_property_ui_text(prop, "IK X Lock", "Disallow movement around the X axis");
1160   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1161   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1162
1163   prop = RNA_def_property(srna, "lock_ik_y", PROP_BOOLEAN, PROP_NONE);
1164   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_YDOF);
1165   RNA_def_property_ui_icon(prop, ICON_UNLOCKED, true);
1166   RNA_def_property_ui_text(prop, "IK Y Lock", "Disallow movement around the Y axis");
1167   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1168   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1169
1170   prop = RNA_def_property(srna, "lock_ik_z", PROP_BOOLEAN, PROP_NONE);
1171   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_ZDOF);
1172   RNA_def_property_ui_icon(prop, ICON_UNLOCKED, true);
1173   RNA_def_property_ui_text(prop, "IK Z Lock", "Disallow movement around the Z axis");
1174   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1175   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1176
1177   prop = RNA_def_property(srna, "use_ik_limit_x", PROP_BOOLEAN, PROP_NONE);
1178   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_XLIMIT);
1179   RNA_def_property_ui_text(prop, "IK X Limit", "Limit movement around the X axis");
1180   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1181   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1182
1183   prop = RNA_def_property(srna, "use_ik_limit_y", PROP_BOOLEAN, PROP_NONE);
1184   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_YLIMIT);
1185   RNA_def_property_ui_text(prop, "IK Y Limit", "Limit movement around the Y axis");
1186   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1187   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1188
1189   prop = RNA_def_property(srna, "use_ik_limit_z", PROP_BOOLEAN, PROP_NONE);
1190   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ZLIMIT);
1191   RNA_def_property_ui_text(prop, "IK Z Limit", "Limit movement around the Z axis");
1192   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1193   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1194
1195   prop = RNA_def_property(srna, "use_ik_rotation_control", PROP_BOOLEAN, PROP_NONE);
1196   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ROTCTL);
1197   RNA_def_property_ui_text(prop, "IK rot control", "Apply channel rotation as IK constraint");
1198   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1199   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1200
1201   prop = RNA_def_property(srna, "use_ik_linear_control", PROP_BOOLEAN, PROP_NONE);
1202   RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_LINCTL);
1203   RNA_def_property_ui_text(
1204       prop, "IK rot control", "Apply channel size as IK constraint if stretching is enabled");
1205   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1206   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1207
1208   prop = RNA_def_property(srna, "ik_min_x", PROP_FLOAT, PROP_ANGLE);
1209   RNA_def_property_float_sdna(prop, NULL, "limitmin[0]");
1210   RNA_def_property_range(prop, -M_PI, 0.0f);
1211   RNA_def_property_ui_text(prop, "IK X Minimum", "Minimum angles for IK Limit");
1212   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1213   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1214
1215   prop = RNA_def_property(srna, "ik_max_x", PROP_FLOAT, PROP_ANGLE);
1216   RNA_def_property_float_sdna(prop, NULL, "limitmax[0]");
1217   RNA_def_property_range(prop, 0.0f, M_PI);
1218   RNA_def_property_ui_text(prop, "IK X Maximum", "Maximum angles for IK Limit");
1219   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1220   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1221
1222   prop = RNA_def_property(srna, "ik_min_y", PROP_FLOAT, PROP_ANGLE);
1223   RNA_def_property_float_sdna(prop, NULL, "limitmin[1]");
1224   RNA_def_property_range(prop, -M_PI, 0.0f);
1225   RNA_def_property_ui_text(prop, "IK Y Minimum", "Minimum angles for IK Limit");
1226   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1227   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1228
1229   prop = RNA_def_property(srna, "ik_max_y", PROP_FLOAT, PROP_ANGLE);
1230   RNA_def_property_float_sdna(prop, NULL, "limitmax[1]");
1231   RNA_def_property_range(prop, 0.0f, M_PI);
1232   RNA_def_property_ui_text(prop, "IK Y Maximum", "Maximum angles for IK Limit");
1233   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1234   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1235
1236   prop = RNA_def_property(srna, "ik_min_z", PROP_FLOAT, PROP_ANGLE);
1237   RNA_def_property_float_sdna(prop, NULL, "limitmin[2]");
1238   RNA_def_property_range(prop, -M_PI, 0.0f);
1239   RNA_def_property_ui_text(prop, "IK Z Minimum", "Minimum angles for IK Limit");
1240   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1241   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1242
1243   prop = RNA_def_property(srna, "ik_max_z", PROP_FLOAT, PROP_ANGLE);
1244   RNA_def_property_float_sdna(prop, NULL, "limitmax[2]");
1245   RNA_def_property_range(prop, 0.0f, M_PI);
1246   RNA_def_property_ui_text(prop, "IK Z Maximum", "Maximum angles for IK Limit");
1247   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1248   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1249
1250   prop = RNA_def_property(srna, "ik_stiffness_x", PROP_FLOAT, PROP_NONE);
1251   RNA_def_property_float_sdna(prop, NULL, "stiffness[0]");
1252   RNA_def_property_range(prop, 0.0f, 0.99f);
1253   RNA_def_property_ui_text(prop, "IK X Stiffness", "IK stiffness around the X axis");
1254   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1255   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1256
1257   prop = RNA_def_property(srna, "ik_stiffness_y", PROP_FLOAT, PROP_NONE);
1258   RNA_def_property_float_sdna(prop, NULL, "stiffness[1]");
1259   RNA_def_property_range(prop, 0.0f, 0.99f);
1260   RNA_def_property_ui_text(prop, "IK Y Stiffness", "IK stiffness around the Y axis");
1261   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1262   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1263
1264   prop = RNA_def_property(srna, "ik_stiffness_z", PROP_FLOAT, PROP_NONE);
1265   RNA_def_property_float_sdna(prop, NULL, "stiffness[2]");
1266   RNA_def_property_range(prop, 0.0f, 0.99f);
1267   RNA_def_property_ui_text(prop, "IK Z Stiffness", "IK stiffness around the Z axis");
1268   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1269   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1270
1271   prop = RNA_def_property(srna, "ik_stretch", PROP_FLOAT, PROP_FACTOR);
1272   RNA_def_property_float_sdna(prop, NULL, "ikstretch");
1273   RNA_def_property_range(prop, 0.0f, 1.0f);
1274   RNA_def_property_ui_text(prop, "IK Stretch", "Allow scaling of the bone for IK");
1275   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1276   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_IK_update");
1277
1278   prop = RNA_def_property(srna, "ik_rotation_weight", PROP_FLOAT, PROP_FACTOR);
1279   RNA_def_property_float_sdna(prop, NULL, "ikrotweight");
1280   RNA_def_property_range(prop, 0.0f, 1.0f);
1281   RNA_def_property_ui_text(prop, "IK Rot Weight", "Weight of rotation constraint for IK");
1282   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1283   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1284
1285   prop = RNA_def_property(srna, "ik_linear_weight", PROP_FLOAT, PROP_FACTOR);
1286   RNA_def_property_float_sdna(prop, NULL, "iklinweight");
1287   RNA_def_property_range(prop, 0.0f, 1.0f);
1288   RNA_def_property_ui_text(prop, "IK Lin Weight", "Weight of scale constraint for IK");
1289   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1290   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1291
1292   /* custom bone shapes */
1293   prop = RNA_def_property(srna, "custom_shape", PROP_POINTER, PROP_NONE);
1294   RNA_def_property_pointer_sdna(prop, NULL, "custom");
1295   RNA_def_property_struct_type(prop, "Object");
1296   RNA_def_property_flag(prop, PROP_EDITABLE);
1297   RNA_def_property_override_flag(prop, PROPOVERRIDE_NO_COMPARISON);
1298   RNA_def_property_pointer_funcs(prop, NULL, "rna_PoseChannel_bone_custom_set", NULL, NULL);
1299   RNA_def_property_ui_text(
1300       prop, "Custom Object", "Object that defines custom draw type for this bone");
1301   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1302   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_dependency_update");
1303
1304   prop = RNA_def_property(srna, "custom_shape_scale", PROP_FLOAT, PROP_NONE);
1305   RNA_def_property_float_sdna(prop, NULL, "custom_scale");
1306   RNA_def_property_range(prop, 0.0f, 1000.0f);
1307   RNA_def_property_ui_text(prop, "Custom Shape Scale", "Adjust the size of the custom shape");
1308   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1309
1310   prop = RNA_def_property(srna, "use_custom_shape_bone_size", PROP_BOOLEAN, PROP_NONE);
1311   RNA_def_property_boolean_negative_sdna(prop, NULL, "drawflag", PCHAN_DRAW_NO_CUSTOM_BONE_SIZE);
1312   RNA_def_property_ui_text(prop, "Use Bone Size", "Scale the custom object by the bone length");
1313   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1314
1315   prop = RNA_def_property(srna, "custom_shape_transform", PROP_POINTER, PROP_NONE);
1316   RNA_def_property_pointer_sdna(prop, NULL, "custom_tx");
1317   RNA_def_property_struct_type(prop, "PoseBone");
1318   RNA_def_property_flag(prop, PROP_EDITABLE | PROP_PTR_NO_OWNERSHIP);
1319   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
1320   RNA_def_property_ui_text(prop,
1321                            "Custom Shape Transform",
1322                            "Bone that defines the display transform of this custom shape");
1323   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1324   RNA_def_property_pointer_funcs(
1325       prop, NULL, "rna_PoseChannel_custom_shape_transform_set", NULL, NULL);
1326   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1327
1328   /* bone groups */
1329   prop = RNA_def_property(srna, "bone_group_index", PROP_INT, PROP_NONE);
1330   RNA_def_property_int_sdna(prop, NULL, "agrp_index");
1331   RNA_def_property_flag(prop, PROP_EDITABLE);
1332   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1333   RNA_def_property_int_funcs(prop,
1334                              "rna_PoseChannel_bone_group_index_get",
1335                              "rna_PoseChannel_bone_group_index_set",
1336                              "rna_PoseChannel_bone_group_index_range");
1337   RNA_def_property_ui_text(
1338       prop, "Bone Group Index", "Bone Group this pose channel belongs to (0=no group)");
1339   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1340   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1341
1342   prop = RNA_def_property(srna, "bone_group", PROP_POINTER, PROP_NONE);
1343   RNA_def_property_struct_type(prop, "BoneGroup");
1344   RNA_def_property_flag(prop, PROP_EDITABLE);
1345   RNA_def_property_pointer_funcs(
1346       prop, "rna_PoseChannel_bone_group_get", "rna_PoseChannel_bone_group_set", NULL, NULL);
1347   RNA_def_property_ui_text(prop, "Bone Group", "Bone Group this pose channel belongs to");
1348   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1349   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1350
1351   /* transform locks */
1352   prop = RNA_def_property(srna, "lock_location", PROP_BOOLEAN, PROP_NONE);
1353   RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_LOCX);
1354   RNA_def_property_array(prop, 3);
1355   RNA_def_property_ui_text(prop, "Lock Location", "Lock editing of location in the interface");
1356   RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1357   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1358   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1359
1360   prop = RNA_def_property(srna, "lock_rotation", PROP_BOOLEAN, PROP_NONE);
1361   RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTX);
1362   RNA_def_property_array(prop, 3);
1363   RNA_def_property_ui_text(prop, "Lock Rotation", "Lock editing of rotation in the interface");
1364   RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1365   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1366   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1367
1368   /* XXX this is sub-optimal - it really should be included above, but due to technical reasons
1369    *     we can't do this! */
1370   prop = RNA_def_property(srna, "lock_rotation_w", PROP_BOOLEAN, PROP_NONE);
1371   RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTW);
1372   RNA_def_property_ui_text(
1373       prop,
1374       "Lock Rotation (4D Angle)",
1375       "Lock editing of 'angle' component of four-component rotations in the interface");
1376   RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1377   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1378   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1379
1380   /* XXX this needs a better name */
1381   prop = RNA_def_property(srna, "lock_rotations_4d", PROP_BOOLEAN, PROP_NONE);
1382   RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROT4D);
1383   RNA_def_property_ui_text(
1384       prop,
1385       "Lock Rotations (4D)",
1386       "Lock editing of four component rotations by components (instead of as Eulers)");
1387   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1388   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1389
1390   prop = RNA_def_property(srna, "lock_scale", PROP_BOOLEAN, PROP_NONE);
1391   RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_SCALEX);
1392   RNA_def_property_array(prop, 3);
1393   RNA_def_property_ui_text(prop, "Lock Scale", "Lock editing of scale in the interface");
1394   RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1395   RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1396   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1397
1398   RNA_api_pose_channel(srna);
1399 }
1400
1401 static void rna_def_pose_itasc(BlenderRNA *brna)
1402 {
1403   static const EnumPropertyItem prop_itasc_mode_items[] = {
1404       {0,
1405        "ANIMATION",
1406        0,
1407        "Animation",
1408        "Stateless solver computing pose starting from current action and non-IK constraints"},
1409       {ITASC_SIMULATION,
1410        "SIMULATION",
1411        0,
1412        "Simulation",
1413        "State-full solver running in real-time context and ignoring actions "
1414        "and non-IK constraints"},
1415       {0, NULL, 0, NULL, NULL},
1416   };
1417   static const EnumPropertyItem prop_itasc_reiteration_items[] = {
1418       {0,
1419        "NEVER",
1420        0,
1421        "Never",
1422        "The solver does not reiterate, not even on first frame (starts from rest pose)"},
1423       {ITASC_INITIAL_REITERATION,
1424        "INITIAL",
1425        0,
1426        "Initial",
1427        "The solver reiterates (converges) on the first frame but not on "
1428        "subsequent frame"},
1429       {ITASC_INITIAL_REITERATION | ITASC_REITERATION,
1430        "ALWAYS",
1431        0,
1432        "Always",
1433        "The solver reiterates (converges) on all frames"},
1434       {0, NULL, 0, NULL, NULL},
1435   };
1436
1437   StructRNA *srna;
1438   PropertyRNA *prop;
1439
1440   srna = RNA_def_struct(brna, "Itasc", "IKParam");
1441   RNA_def_struct_sdna(srna, "bItasc");
1442   RNA_def_struct_ui_text(srna, "bItasc", "Parameters for the iTaSC IK solver");
1443
1444   prop = RNA_def_property(srna, "precision", PROP_FLOAT, PROP_NONE);
1445   RNA_def_property_float_sdna(prop, NULL, "precision");
1446   RNA_def_property_range(prop, 0.0f, 0.1f);
1447   RNA_def_property_ui_text(prop, "Precision", "Precision of convergence in case of reiteration");
1448   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1449
1450   prop = RNA_def_property(srna, "iterations", PROP_INT, PROP_NONE);
1451   RNA_def_property_int_sdna(prop, NULL, "numiter");
1452   RNA_def_property_range(prop, 0, 1000);
1453   RNA_def_property_ui_text(
1454       prop, "Iterations", "Maximum number of iterations for convergence in case of reiteration");
1455   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1456
1457   prop = RNA_def_property(srna, "step_count", PROP_INT, PROP_NONE);
1458   RNA_def_property_int_sdna(prop, NULL, "numstep");
1459   RNA_def_property_range(prop, 1.f, 50.f);
1460   RNA_def_property_ui_text(prop, "Num Steps", "Divide the frame interval into this many steps");
1461   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1462
1463   prop = RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
1464   RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
1465   RNA_def_property_enum_items(prop, prop_itasc_mode_items);
1466   RNA_def_property_ui_text(prop, "Mode", NULL);
1467   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update_rebuild");
1468
1469   prop = RNA_def_property(srna, "reiteration_method", PROP_ENUM, PROP_NONE);
1470   RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
1471   RNA_def_property_enum_items(prop, prop_itasc_reiteration_items);
1472   RNA_def_property_ui_text(prop,
1473                            "Reiteration",
1474                            "Defines if the solver is allowed to reiterate (converge until "
1475                            "precision is met) on none, first or all frames");
1476   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1477
1478   prop = RNA_def_property(srna, "use_auto_step", PROP_BOOLEAN, PROP_NONE);
1479   RNA_def_property_boolean_sdna(prop, NULL, "flag", ITASC_AUTO_STEP);
1480   RNA_def_property_ui_text(prop,
1481                            "Auto Step",
1482                            "Automatically determine the optimal number of steps for best "
1483                            "performance/accuracy trade off");
1484   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1485
1486   prop = RNA_def_property(srna, "step_min", PROP_FLOAT, PROP_FACTOR);
1487   RNA_def_property_float_sdna(prop, NULL, "minstep");
1488   RNA_def_property_range(prop, 0.0f, 0.1f);
1489   RNA_def_property_ui_text(
1490       prop, "Min Step", "Lower bound for timestep in second in case of automatic substeps");
1491   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1492
1493   prop = RNA_def_property(srna, "step_max", PROP_FLOAT, PROP_FACTOR);
1494   RNA_def_property_float_sdna(prop, NULL, "maxstep");
1495   RNA_def_property_range(prop, 0.0f, 1.0f);
1496   RNA_def_property_ui_text(
1497       prop, "Max Step", "Higher bound for timestep in second in case of automatic substeps");
1498   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1499
1500   prop = RNA_def_property(srna, "feedback", PROP_FLOAT, PROP_NONE);
1501   RNA_def_property_float_sdna(prop, NULL, "feedback");
1502   RNA_def_property_range(prop, 0.0f, 100.0f);
1503   RNA_def_property_ui_text(
1504       prop,
1505       "Feedback",
1506       "Feedback coefficient for error correction, average response time is 1/feedback "
1507       "(default=20)");
1508   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1509
1510   prop = RNA_def_property(srna, "velocity_max", PROP_FLOAT, PROP_NONE);
1511   RNA_def_property_float_sdna(prop, NULL, "maxvel");
1512   RNA_def_property_range(prop, 0.0f, 100.0f);
1513   RNA_def_property_ui_text(prop, "Max Velocity", "Maximum joint velocity in rad/s (default=50)");
1514   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1515
1516   prop = RNA_def_property(srna, "solver", PROP_ENUM, PROP_NONE);
1517   RNA_def_property_enum_sdna(prop, NULL, "solver");
1518   RNA_def_property_enum_items(prop, prop_solver_items);
1519   RNA_def_property_ui_text(
1520       prop, "Solver", "Solving method selection: automatic damping or manual damping");
1521   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update_rebuild");
1522
1523   prop = RNA_def_property(srna, "damping_max", PROP_FLOAT, PROP_FACTOR);
1524   RNA_def_property_float_sdna(prop, NULL, "dampmax");
1525   RNA_def_property_range(prop, 0.0f, 1.0f);
1526   RNA_def_property_ui_text(prop,
1527                            "Damp",
1528                            "Maximum damping coefficient when singular value is nearly 0 "
1529                            "(higher values=more stability, less reactivity - default=0.5)");
1530   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1531
1532   prop = RNA_def_property(srna, "damping_epsilon", PROP_FLOAT, PROP_FACTOR);
1533   RNA_def_property_float_sdna(prop, NULL, "dampeps");
1534   RNA_def_property_range(prop, 0.0f, 1.0f);
1535   RNA_def_property_ui_text(prop,
1536                            "Epsilon",
1537                            "Singular value under which damping is progressively applied "
1538                            "(higher values=more stability, less reactivity - default=0.1)");
1539   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Itasc_update");
1540 }
1541
1542 static void rna_def_pose_ikparam(BlenderRNA *brna)
1543 {
1544   StructRNA *srna;
1545   PropertyRNA *prop;
1546
1547   srna = RNA_def_struct(brna, "IKParam", NULL);
1548   RNA_def_struct_sdna(srna, "bIKParam");
1549   RNA_def_struct_ui_text(srna, "IKParam", "Base type for IK solver parameters");
1550   RNA_def_struct_refine_func(srna, "rna_IKParam_refine");
1551
1552   prop = RNA_def_property(srna, "ik_solver", PROP_ENUM, PROP_NONE);
1553   RNA_def_property_enum_sdna(prop, NULL, "iksolver");
1554   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1555   RNA_def_property_enum_items(prop, prop_iksolver_items);
1556   RNA_def_property_ui_text(prop, "IK Solver", "IK solver for which these parameters are defined");
1557 }
1558
1559 /* pose.bone_groups */
1560 static void rna_def_bone_groups(BlenderRNA *brna, PropertyRNA *cprop)
1561 {
1562   StructRNA *srna;
1563   PropertyRNA *prop;
1564
1565   FunctionRNA *func;
1566   PropertyRNA *parm;
1567
1568   RNA_def_property_srna(cprop, "BoneGroups");
1569   srna = RNA_def_struct(brna, "BoneGroups", NULL);
1570   RNA_def_struct_sdna(srna, "bPose");
1571   RNA_def_struct_ui_text(srna, "Bone Groups", "Collection of bone groups");
1572
1573   func = RNA_def_function(srna, "new", "rna_bone_group_new");
1574   RNA_def_function_ui_description(func, "Add a new bone group to the object");
1575   RNA_def_function_flag(func, FUNC_USE_SELF_ID); /* ID needed for refresh */
1576   RNA_def_string(func, "name", "Group", MAX_NAME, "", "Name of the new group");
1577   /* return type */
1578   parm = RNA_def_pointer(func, "group", "BoneGroup", "", "New bone group");
1579   RNA_def_function_return(func, parm);
1580
1581   func = RNA_def_function(srna, "remove", "rna_bone_group_remove");
1582   RNA_def_function_ui_description(func, "Remove a bone group from this object");
1583   RNA_def_function_flag(func, FUNC_USE_REPORTS | FUNC_USE_SELF_ID); /* ID needed for refresh */
1584   /* bone group to remove */
1585   parm = RNA_def_pointer(func, "group", "BoneGroup", "", "Removed bone group");
1586   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
1587   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
1588
1589   prop = RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1590   RNA_def_property_struct_type(prop, "BoneGroup");
1591   RNA_def_property_flag(prop, PROP_EDITABLE);
1592   RNA_def_property_pointer_funcs(
1593       prop, "rna_Pose_active_bone_group_get", "rna_Pose_active_bone_group_set", NULL, NULL);
1594   RNA_def_property_ui_text(prop, "Active Bone Group", "Active bone group for this pose");
1595   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1596
1597   prop = RNA_def_property(srna, "active_index", PROP_INT, PROP_UNSIGNED);
1598   RNA_def_property_int_sdna(prop, NULL, "active_group");
1599   RNA_def_property_int_funcs(prop,
1600                              "rna_Pose_active_bone_group_index_get",
1601                              "rna_Pose_active_bone_group_index_set",
1602                              "rna_Pose_active_bone_group_index_range");
1603   RNA_def_property_ui_text(prop, "Active Bone Group Index", "Active index in bone groups array");
1604   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_update");
1605 }
1606
1607 static void rna_def_pose(BlenderRNA *brna)
1608 {
1609   StructRNA *srna;
1610   PropertyRNA *prop;
1611
1612   /* struct definition */
1613   srna = RNA_def_struct(brna, "Pose", NULL);
1614   RNA_def_struct_sdna(srna, "bPose");
1615   RNA_def_struct_ui_text(
1616       srna, "Pose", "A collection of pose channels, including settings for animating bones");
1617
1618   /* pose channels */
1619   prop = RNA_def_property(srna, "bones", PROP_COLLECTION, PROP_NONE);
1620   RNA_def_property_collection_sdna(prop, NULL, "chanbase", NULL);
1621   RNA_def_property_struct_type(prop, "PoseBone");
1622   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
1623   RNA_def_property_ui_text(prop, "Pose Bones", "Individual pose bones for the armature");
1624   /* can be removed, only for fast lookup */
1625   RNA_def_property_collection_funcs(
1626       prop, NULL, NULL, NULL, NULL, NULL, NULL, "rna_PoseBones_lookup_string", NULL);
1627
1628   /* bone groups */
1629   prop = RNA_def_property(srna, "bone_groups", PROP_COLLECTION, PROP_NONE);
1630   RNA_def_property_collection_sdna(prop, NULL, "agroups", NULL);
1631   RNA_def_property_struct_type(prop, "BoneGroup");
1632   RNA_def_property_ui_text(prop, "Bone Groups", "Groups of the bones");
1633   rna_def_bone_groups(brna, prop);
1634
1635   /* ik solvers */
1636   prop = RNA_def_property(srna, "ik_solver", PROP_ENUM, PROP_NONE);
1637   RNA_def_property_enum_sdna(prop, NULL, "iksolver");
1638   RNA_def_property_enum_funcs(prop, NULL, "rna_Pose_ik_solver_set", NULL);
1639   RNA_def_property_enum_items(prop, prop_iksolver_items);
1640   RNA_def_property_ui_text(prop, "IK Solver", "Selection of IK solver for IK chain");
1641   RNA_def_property_update(prop, NC_OBJECT | ND_POSE, "rna_Pose_ik_solver_update");
1642
1643   prop = RNA_def_property(srna, "ik_param", PROP_POINTER, PROP_NONE);
1644   RNA_def_property_struct_type(prop, "IKParam");
1645   RNA_def_property_pointer_funcs(
1646       prop, "rna_Pose_ikparam_get", NULL, "rna_Pose_ikparam_typef", NULL);
1647   RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1648   RNA_def_property_ui_text(prop, "IK Param", "Parameters for IK solver");
1649
1650   /* pose edit options */
1651   prop = RNA_def_property(srna, "use_mirror_x", PROP_BOOLEAN, PROP_NONE);
1652   RNA_def_property_boolean_sdna(prop, NULL, "flag", POSE_MIRROR_EDIT);
1653   RNA_def_property_ui_text(
1654       prop, "X-Axis Mirror", "Apply changes to matching bone on opposite side of X-Axis");
1655   RNA_def_struct_path_func(srna, "rna_Pose_path");
1656   RNA_def_property_update(prop, 0, "rna_Pose_update");
1657   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1658
1659   prop = RNA_def_property(srna, "use_mirror_relative", PROP_BOOLEAN, PROP_NONE);
1660   RNA_def_property_boolean_sdna(prop, NULL, "flag", POSE_MIRROR_RELATIVE);
1661   RNA_def_property_ui_text(
1662       prop, "Relative Mirror", "Apply relative transformations in X-mirror mode");
1663   RNA_def_struct_path_func(srna, "rna_Pose_path");
1664   RNA_def_property_update(prop, 0, "rna_Pose_update");
1665   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1666
1667   prop = RNA_def_property(srna, "use_auto_ik", PROP_BOOLEAN, PROP_NONE);
1668   RNA_def_property_boolean_sdna(prop, NULL, "flag", POSE_AUTO_IK);
1669   RNA_def_property_ui_text(
1670       prop, "Auto IK", "Add temporary IK constraints while grabbing bones in Pose Mode");
1671   RNA_def_struct_path_func(srna, "rna_Pose_path");
1672   RNA_def_property_update(prop, 0, "rna_Pose_update");
1673   RNA_def_property_flag(prop, PROP_LIB_EXCEPTION);
1674
1675   /* animviz */
1676   rna_def_animviz_common(srna);
1677
1678   RNA_api_pose(srna);
1679 }
1680
1681 void RNA_def_pose(BlenderRNA *brna)
1682 {
1683   rna_def_pose(brna);
1684   rna_def_pose_channel(brna);
1685   rna_def_pose_ikparam(brna);
1686   rna_def_pose_itasc(brna);
1687   rna_def_bone_group(brna);
1688 }
1689
1690 #endif