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