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