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