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