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