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