fix [#26920] working with bones causes segmetation fault.
[blender-staging.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 *bmain, Scene *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 *bmain, Scene *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 *bmain, Scene *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
479                 ED_object_constraint_update(ob);
480
481                 constraints_set_active(&pchan->constraints, NULL);
482
483                 if (is_ik) {
484                         BIK_clear_data(ob->pose);
485                 }
486
487                 WM_main_add_notifier(NC_OBJECT|ND_CONSTRAINT|NA_REMOVED, id);
488         }
489 }
490
491 static int rna_PoseChannel_proxy_editable(PointerRNA *ptr)
492 {
493         Object *ob= (Object*)ptr->id.data;
494         bArmature *arm= ob->data;
495         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
496         
497         return (ob->proxy && pchan->bone && (pchan->bone->layer & arm->layer_protected))? 0: PROP_EDITABLE;
498 }
499
500 static int rna_PoseChannel_location_editable(PointerRNA *ptr, int index)
501 {
502         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
503
504         /* only if the axis in question is locked, not editable... */
505         if ((index == 0) && (pchan->protectflag & OB_LOCK_LOCX))
506                 return 0;
507         else if ((index == 1) && (pchan->protectflag & OB_LOCK_LOCY))
508                 return 0;
509         else if ((index == 2) && (pchan->protectflag & OB_LOCK_LOCZ))
510                 return 0;
511         else
512                 return PROP_EDITABLE;
513 }
514
515 static int rna_PoseChannel_scale_editable(PointerRNA *ptr, int index)
516 {
517         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
518         
519         /* only if the axis in question is locked, not editable... */
520         if ((index == 0) && (pchan->protectflag & OB_LOCK_SCALEX))
521                 return 0;
522         else if ((index == 1) && (pchan->protectflag & OB_LOCK_SCALEY))
523                 return 0;
524         else if ((index == 2) && (pchan->protectflag & OB_LOCK_SCALEZ))
525                 return 0;
526         else
527                 return PROP_EDITABLE;
528 }
529
530 static int rna_PoseChannel_rotation_euler_editable(PointerRNA *ptr, int index)
531 {
532         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
533         
534         /* only if the axis in question is locked, not editable... */
535         if ((index == 0) && (pchan->protectflag & OB_LOCK_ROTX))
536                 return 0;
537         else if ((index == 1) && (pchan->protectflag & OB_LOCK_ROTY))
538                 return 0;
539         else if ((index == 2) && (pchan->protectflag & OB_LOCK_ROTZ))
540                 return 0;
541         else
542                 return PROP_EDITABLE;
543 }
544
545 static int rna_PoseChannel_rotation_4d_editable(PointerRNA *ptr, int index)
546 {
547         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
548         
549         /* only consider locks if locking components individually... */
550         if (pchan->protectflag & OB_LOCK_ROT4D) {
551                 /* only if the axis in question is locked, not editable... */
552                 if ((index == 0) && (pchan->protectflag & OB_LOCK_ROTW))
553                         return 0;
554                 else if ((index == 1) && (pchan->protectflag & OB_LOCK_ROTX))
555                         return 0;
556                 else if ((index == 2) && (pchan->protectflag & OB_LOCK_ROTY))
557                         return 0;
558                 else if ((index == 3) && (pchan->protectflag & OB_LOCK_ROTZ))
559                         return 0;
560         }
561                 
562         return PROP_EDITABLE;
563 }
564
565 /* not essential, but much faster then the default lookup function */
566 int rna_PoseBones_lookup_string(PointerRNA *ptr, const char *key, PointerRNA *r_ptr)
567 {
568         bPose *pose= (bPose*)ptr->data;
569         bPoseChannel *pchan= get_pose_channel(pose, key);
570         if(pchan) {
571                 RNA_pointer_create(ptr->id.data, &RNA_PoseBone, pchan, r_ptr);
572                 return TRUE;
573         }
574         else {
575                 return FALSE;
576         }
577 }
578
579 static void rna_PoseChannel_matrix_basis_get(PointerRNA *ptr, float *values)
580 {
581         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
582         pchan_to_mat4(pchan, (float (*)[4])values);
583 }
584
585 static void rna_PoseChannel_matrix_basis_set(PointerRNA *ptr, const float *values)
586 {
587         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
588         pchan_apply_mat4(pchan, (float (*)[4])values, FALSE); /* no compat for predictable result */
589 }
590
591 #else
592
593 static void rna_def_bone_group(BlenderRNA *brna)
594 {
595         static EnumPropertyItem prop_colorSets_items[] = {
596                 {0, "DEFAULT", 0, "Default Colors", ""},
597                 {1, "THEME01", 0, "01 - Theme Color Set", ""},
598                 {2, "THEME02", 0, "02 - Theme Color Set", ""},
599                 {3, "THEME03", 0, "03 - Theme Color Set", ""},
600                 {4, "THEME04", 0, "04 - Theme Color Set", ""},
601                 {5, "THEME05", 0, "05 - Theme Color Set", ""},
602                 {6, "THEME06", 0, "06 - Theme Color Set", ""},
603                 {7, "THEME07", 0, "07 - Theme Color Set", ""},
604                 {8, "THEME08", 0, "08 - Theme Color Set", ""},
605                 {9, "THEME09", 0, "09 - Theme Color Set", ""},
606                 {10, "THEME10", 0, "10 - Theme Color Set", ""},
607                 {11, "THEME11", 0, "11 - Theme Color Set", ""},
608                 {12, "THEME12", 0, "12 - Theme Color Set", ""},
609                 {13, "THEME13", 0, "13 - Theme Color Set", ""},
610                 {14, "THEME14", 0, "14 - Theme Color Set", ""},
611                 {15, "THEME15", 0, "15 - Theme Color Set", ""},
612                 {16, "THEME16", 0, "16 - Theme Color Set", ""},
613                 {17, "THEME17", 0, "17 - Theme Color Set", ""},
614                 {18, "THEME18", 0, "18 - Theme Color Set", ""},
615                 {19, "THEME19", 0, "19 - Theme Color Set", ""},
616                 {20, "THEME20", 0, "20 - Theme Color Set", ""},
617                 {-1, "CUSTOM", 0, "Custom Color Set", ""},
618                 {0, NULL, 0, NULL, NULL}};
619         
620         StructRNA *srna;
621         PropertyRNA *prop;
622         
623         /* struct */
624         srna= RNA_def_struct(brna, "BoneGroup", NULL);
625         RNA_def_struct_sdna(srna, "bActionGroup");
626         RNA_def_struct_ui_text(srna, "Bone Group", "Groups of Pose Channels (Bones)");
627         RNA_def_struct_ui_icon(srna, ICON_GROUP_BONE);
628         
629         /* name */
630         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
631         RNA_def_property_ui_text(prop, "Name", "");
632         RNA_def_struct_name_property(srna, prop);
633         
634         // TODO: add some runtime-collections stuff to access grouped bones 
635         
636         /* color set + colors */
637         prop= RNA_def_property(srna, "color_set", PROP_ENUM, PROP_NONE);
638         RNA_def_property_enum_sdna(prop, NULL, "customCol");
639         RNA_def_property_enum_items(prop, prop_colorSets_items);
640         RNA_def_property_enum_funcs(prop, NULL, "rna_BoneGroup_color_set_set", NULL);
641         RNA_def_property_ui_text(prop, "Color Set", "Custom color set to use");
642         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
643         
644                 // TODO: editing the colors for this should result in changes to the color type...
645         prop= RNA_def_property(srna, "colors", PROP_POINTER, PROP_NONE);
646         RNA_def_property_flag(prop, PROP_NEVER_NULL);
647         RNA_def_property_struct_type(prop, "ThemeBoneColorSet");
648         RNA_def_property_pointer_sdna(prop, NULL, "cs"); /* NOTE: the DNA data is not really a pointer, but this code works :) */
649         RNA_def_property_ui_text(prop, "Colors", "Copy of the colors associated with the group's color set");
650         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
651 }
652
653 static EnumPropertyItem prop_iksolver_items[] = {
654         {IKSOLVER_LEGACY, "LEGACY", 0, "Legacy", "Original IK solver"},
655         {IKSOLVER_ITASC, "ITASC", 0, "iTaSC", "Multi constraint, stateful IK solver"},
656         {0, NULL, 0, NULL, NULL}};
657
658 static EnumPropertyItem prop_solver_items[] = {
659         {ITASC_SOLVER_SDLS, "SDLS", 0, "SDLS", "Selective Damped Least Square"},
660         {ITASC_SOLVER_DLS, "DLS", 0, "DLS", "Damped Least Square with Numerical Filtering"},
661         {0, NULL, 0, NULL, NULL}};
662
663
664 static void rna_def_pose_channel_constraints(BlenderRNA *brna, PropertyRNA *cprop)
665 {
666         StructRNA *srna;
667         PropertyRNA *prop;
668
669         FunctionRNA *func;
670         PropertyRNA *parm;
671
672         RNA_def_property_srna(cprop, "PoseBoneConstraints");
673         srna= RNA_def_struct(brna, "PoseBoneConstraints", NULL);
674         RNA_def_struct_sdna(srna, "bPoseChannel");
675         RNA_def_struct_ui_text(srna, "PoseBone Constraints", "Collection of pose bone constraints");
676
677         /* Collection active property */
678         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
679         RNA_def_property_struct_type(prop, "Constraint");
680         RNA_def_property_pointer_funcs(prop, "rna_PoseChannel_active_constraint_get", "rna_PoseChannel_active_constraint_set", NULL, NULL);
681         RNA_def_property_flag(prop, PROP_EDITABLE);
682         RNA_def_property_ui_text(prop, "Active Constraint", "Active PoseChannel constraint");
683
684
685         /* Constraint collection */
686         func= RNA_def_function(srna, "new", "rna_PoseChannel_constraints_new");
687         RNA_def_function_ui_description(func, "Add a constraint to this object");
688         /* return type */
689         parm= RNA_def_pointer(func, "constraint", "Constraint", "", "New constraint.");
690         RNA_def_function_return(func, parm);
691         /* constraint to add */
692         parm= RNA_def_enum(func, "type", constraint_type_items, 1, "", "Constraint type to add.");
693         RNA_def_property_flag(parm, PROP_REQUIRED);
694
695         func= RNA_def_function(srna, "remove", "rna_PoseChannel_constraints_remove");
696         RNA_def_function_ui_description(func, "Remove a constraint from this object.");
697         RNA_def_function_flag(func, FUNC_USE_REPORTS|FUNC_USE_SELF_ID); /* ID needed for refresh */
698         /* constraint to remove */
699         parm= RNA_def_pointer(func, "constraint", "Constraint", "", "Removed constraint.");
700         RNA_def_property_flag(parm, PROP_REQUIRED|PROP_NEVER_NULL);
701 }
702
703 static void rna_def_pose_channel(BlenderRNA *brna)
704 {
705         // XXX: this RNA enum define is currently duplicated for objects, since there is some text here which is not applicable
706         static EnumPropertyItem prop_rotmode_items[] = {
707                 {ROT_MODE_QUAT, "QUATERNION", 0, "Quaternion (WXYZ)", "No Gimbal Lock (default)"},
708                 {ROT_MODE_XYZ, "XYZ", 0, "XYZ Euler", "XYZ Rotation Order. Prone to Gimbal Lock"},
709                 {ROT_MODE_XZY, "XZY", 0, "XZY Euler", "XZY Rotation Order. Prone to Gimbal Lock"},
710                 {ROT_MODE_YXZ, "YXZ", 0, "YXZ Euler", "YXZ Rotation Order. Prone to Gimbal Lock"},
711                 {ROT_MODE_YZX, "YZX", 0, "YZX Euler", "YZX Rotation Order. Prone to Gimbal Lock"},
712                 {ROT_MODE_ZXY, "ZXY", 0, "ZXY Euler", "ZXY Rotation Order. Prone to Gimbal Lock"},
713                 {ROT_MODE_ZYX, "ZYX", 0, "ZYX Euler", "ZYX Rotation Order. Prone to Gimbal Lock"},
714                 {ROT_MODE_AXISANGLE, "AXIS_ANGLE", 0, "Axis Angle", "Axis Angle (W+XYZ). Defines a rotation around some axis defined by 3D-Vector"},
715                 {0, NULL, 0, NULL, NULL}};
716                 
717         static float default_quat[4] = {1,0,0,0};       /* default quaternion values */
718         static float default_axisAngle[4] = {0,0,1,0};  /* default axis-angle rotation values */
719         static float default_scale[3] = {1,1,1}; /* default scale values */
720         
721         const int matrix_dimsize[]= {4, 4};
722         
723         StructRNA *srna;
724         PropertyRNA *prop;
725
726         srna= RNA_def_struct(brna, "PoseBone", NULL);
727         RNA_def_struct_sdna(srna, "bPoseChannel");
728         RNA_def_struct_ui_text(srna, "Pose Bone", "Channel defining pose data for a bone in a Pose");
729         RNA_def_struct_path_func(srna, "rna_PoseBone_path");
730         RNA_def_struct_idprops_func(srna, "rna_PoseBone_idprops");
731         
732         /* Bone Constraints */
733         prop= RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
734         RNA_def_property_struct_type(prop, "Constraint");
735         RNA_def_property_ui_text(prop, "Constraints", "Constraints that act on this PoseChannel");
736
737         rna_def_pose_channel_constraints(brna, prop);
738
739         /* Name + Selection Status */
740         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
741         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_PoseChannel_name_set");
742         RNA_def_property_ui_text(prop, "Name", "");
743         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
744         RNA_def_struct_name_property(srna, prop);
745
746         /* Baked Bone Path cache data */
747         rna_def_motionpath_common(srna);
748         
749         /* Relationships to other bones */
750         prop= RNA_def_property(srna, "bone", PROP_POINTER, PROP_NONE);
751         RNA_def_property_flag(prop, PROP_NEVER_NULL);
752         RNA_def_property_struct_type(prop, "Bone");
753         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
754         RNA_def_property_ui_text(prop, "Bone", "Bone associated with this PoseBone");
755
756         prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
757         RNA_def_property_struct_type(prop, "PoseBone");
758         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
759         RNA_def_property_ui_text(prop, "Parent", "Parent of this pose bone");
760
761         prop= RNA_def_property(srna, "child", PROP_POINTER, PROP_NONE);
762         RNA_def_property_struct_type(prop, "PoseBone");
763         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
764         RNA_def_property_ui_text(prop, "Child", "Child of this pose bone");
765         
766         /* Transformation settings */
767         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_TRANSLATION);
768         RNA_def_property_float_sdna(prop, NULL, "loc");
769         RNA_def_property_editable_array_func(prop, "rna_PoseChannel_location_editable");
770         RNA_def_property_ui_text(prop, "Location", "");
771         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable"); // XXX... disabled, since proxy-locked layers are currently used for ensuring proxy-syncing too
772         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
773
774         prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);
775         RNA_def_property_float_sdna(prop, NULL, "size");
776         RNA_def_property_editable_array_func(prop, "rna_PoseChannel_scale_editable");
777         RNA_def_property_float_array_default(prop, default_scale);
778         RNA_def_property_ui_text(prop, "Scale", "");
779         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable"); // XXX... disabled, since proxy-locked layers are currently used for ensuring proxy-syncing too
780         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
781
782         prop= RNA_def_property(srna, "rotation_quaternion", PROP_FLOAT, PROP_QUATERNION);
783         RNA_def_property_float_sdna(prop, NULL, "quat");
784         RNA_def_property_editable_array_func(prop, "rna_PoseChannel_rotation_4d_editable");
785         RNA_def_property_float_array_default(prop, default_quat);
786         RNA_def_property_ui_text(prop, "Quaternion Rotation", "Rotation in Quaternions");
787         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable"); // XXX... disabled, since proxy-locked layers are currently used for ensuring proxy-syncing too
788         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
789         
790                 /* XXX: for axis-angle, it would have been nice to have 2 separate fields for UI purposes, but
791                  * having a single one is better for Keyframing and other property-management situations...
792                  */
793         prop= RNA_def_property(srna, "rotation_axis_angle", PROP_FLOAT, PROP_AXISANGLE);
794         RNA_def_property_array(prop, 4); // TODO: maybe we'll need to define the 'default value' getter too...
795         RNA_def_property_float_funcs(prop, "rna_PoseChannel_rotation_axis_angle_get", "rna_PoseChannel_rotation_axis_angle_set", NULL);
796         RNA_def_property_editable_array_func(prop, "rna_PoseChannel_rotation_4d_editable");
797         RNA_def_property_float_array_default(prop, default_axisAngle);
798         RNA_def_property_ui_text(prop, "Axis-Angle Rotation", "Angle of Rotation for Axis-Angle rotation representation");
799         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable"); // XXX... disabled, since proxy-locked layers are currently used for ensuring proxy-syncing too
800         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
801         
802         prop= RNA_def_property(srna, "rotation_euler", PROP_FLOAT, PROP_EULER);
803         RNA_def_property_float_sdna(prop, NULL, "eul");
804         RNA_def_property_editable_array_func(prop, "rna_PoseChannel_rotation_euler_editable");
805         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable"); // XXX... disabled, since proxy-locked layers are currently used for ensuring proxy-syncing too
806         RNA_def_property_ui_text(prop, "Euler Rotation", "Rotation in Eulers");
807         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
808         
809         prop= RNA_def_property(srna, "rotation_mode", PROP_ENUM, PROP_NONE);
810         RNA_def_property_enum_sdna(prop, NULL, "rotmode");
811         RNA_def_property_enum_items(prop, prop_rotmode_items); // XXX move to using a single define of this someday
812         RNA_def_property_enum_funcs(prop, NULL, "rna_PoseChannel_rotation_mode_set", NULL);
813         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable"); // XXX... disabled, since proxy-locked layers are currently used for ensuring proxy-syncing too
814         RNA_def_property_ui_text(prop, "Rotation Mode", "");
815         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
816         
817         /* transform matrices - should be read-only since these are set directly by AnimSys evaluation */
818         prop= RNA_def_property(srna, "matrix_channel", PROP_FLOAT, PROP_MATRIX);
819         RNA_def_property_float_sdna(prop, NULL, "chan_mat");
820         RNA_def_property_multi_array(prop, 2, matrix_dimsize);
821         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
822         RNA_def_property_ui_text(prop, "Channel Matrix", "4x4 matrix, before constraints");
823
824         /* writable because it touches loc/scale/rot directly */
825         prop= RNA_def_property(srna, "matrix_basis", PROP_FLOAT, PROP_MATRIX);
826         RNA_def_property_multi_array(prop, 2, matrix_dimsize);
827         RNA_def_property_ui_text(prop, "Basis Matrix", "Provides an alternative access to loc/scale/rotation relative to the parent and own rest bone.");
828         RNA_def_property_float_funcs(prop, "rna_PoseChannel_matrix_basis_get", "rna_PoseChannel_matrix_basis_set", NULL);
829         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
830         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
831
832         /* final matrix */
833         prop= RNA_def_property(srna, "matrix", PROP_FLOAT, PROP_MATRIX);
834         RNA_def_property_float_sdna(prop, NULL, "pose_mat");
835         RNA_def_property_multi_array(prop, 2, matrix_dimsize);
836         RNA_def_property_clear_flag(prop, PROP_EDITABLE); 
837         RNA_def_property_ui_text(prop, "Pose Matrix", "Final 4x4 matrix after constraints and drivers are applied (object space)");
838
839         /* Head/Tail Coordinates (in Pose Space) - Automatically calculated... */
840         prop= RNA_def_property(srna, "head", PROP_FLOAT, PROP_TRANSLATION);
841         RNA_def_property_float_sdna(prop, NULL, "pose_head");
842         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
843         RNA_def_property_ui_text(prop, "Pose Head Position", "Location of head of the channel's bone");
844
845         prop= RNA_def_property(srna, "tail", PROP_FLOAT, PROP_TRANSLATION);
846         RNA_def_property_float_sdna(prop, NULL, "pose_tail");
847         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
848         RNA_def_property_ui_text(prop, "Pose Tail Position", "Location of tail of the channel's bone");
849         
850         /* IK Settings */
851         prop= RNA_def_property(srna, "is_in_ik_chain", PROP_BOOLEAN, PROP_NONE);
852         RNA_def_property_boolean_funcs(prop,  "rna_PoseChannel_has_ik_get", NULL);
853         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
854         RNA_def_property_ui_text(prop, "Has IK", "Is part of an IK chain");
855         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
856
857         prop= RNA_def_property(srna, "lock_ik_x", PROP_BOOLEAN, PROP_NONE);
858         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_XDOF);
859         RNA_def_property_ui_text(prop, "IK X Lock", "Disallow movement around the X axis");
860         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
861         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
862
863         prop= RNA_def_property(srna, "lock_ik_y", PROP_BOOLEAN, PROP_NONE);
864         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_YDOF);
865         RNA_def_property_ui_text(prop, "IK Y Lock", "Disallow movement around the Y axis");
866         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
867         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
868
869         prop= RNA_def_property(srna, "lock_ik_z", PROP_BOOLEAN, PROP_NONE);
870         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_ZDOF);
871         RNA_def_property_ui_text(prop, "IK Z Lock", "Disallow movement around the Z axis");
872         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
873         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
874
875         prop= RNA_def_property(srna, "use_ik_limit_x", PROP_BOOLEAN, PROP_NONE);
876         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_XLIMIT);
877         RNA_def_property_ui_text(prop, "IK X Limit", "Limit movement around the X axis");
878         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
879         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
880
881         prop= RNA_def_property(srna, "use_ik_limit_y", PROP_BOOLEAN, PROP_NONE);
882         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_YLIMIT);
883         RNA_def_property_ui_text(prop, "IK Y Limit", "Limit movement around the Y axis");
884         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
885         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
886
887         prop= RNA_def_property(srna, "use_ik_limit_z", PROP_BOOLEAN, PROP_NONE);
888         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ZLIMIT);
889         RNA_def_property_ui_text(prop, "IK Z Limit", "Limit movement around the Z axis");
890         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
891         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
892         
893         prop= RNA_def_property(srna, "use_ik_rotation_control", PROP_BOOLEAN, PROP_NONE);
894         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ROTCTL);
895         RNA_def_property_ui_text(prop, "IK rot control", "Apply channel rotation as IK constraint");
896         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
897         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
898         
899         prop= RNA_def_property(srna, "use_ik_linear_control", PROP_BOOLEAN, PROP_NONE);
900         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_LINCTL);
901         RNA_def_property_ui_text(prop, "IK rot control", "Apply channel size as IK constraint if stretching is enabled");
902         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
903         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
904         
905         prop= RNA_def_property(srna, "ik_min_x", PROP_FLOAT, PROP_ANGLE);
906         RNA_def_property_float_sdna(prop, NULL, "limitmin[0]");
907         RNA_def_property_range(prop, -M_PI, 0.0f);
908         RNA_def_property_ui_text(prop, "IK X Minimum", "Minimum angles for IK Limit");
909         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
910         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
911
912         prop= RNA_def_property(srna, "ik_max_x", PROP_FLOAT, PROP_ANGLE);
913         RNA_def_property_float_sdna(prop, NULL, "limitmax[0]");
914         RNA_def_property_range(prop, 0.0f, M_PI);
915         RNA_def_property_ui_text(prop, "IK X Maximum", "Maximum angles for IK Limit");
916         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
917         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
918
919         prop= RNA_def_property(srna, "ik_min_y", PROP_FLOAT, PROP_ANGLE);
920         RNA_def_property_float_sdna(prop, NULL, "limitmin[1]");
921         RNA_def_property_range(prop, -M_PI, 0.0f);
922         RNA_def_property_ui_text(prop, "IK Y Minimum", "Minimum angles for IK Limit");
923         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
924         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
925
926         prop= RNA_def_property(srna, "ik_max_y", PROP_FLOAT, PROP_ANGLE);
927         RNA_def_property_float_sdna(prop, NULL, "limitmax[1]");
928         RNA_def_property_range(prop, 0.0f, M_PI);
929         RNA_def_property_ui_text(prop, "IK Y Maximum", "Maximum angles for IK Limit");
930         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
931         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_IK_update");
932
933         prop= RNA_def_property(srna, "ik_min_z", PROP_FLOAT, PROP_ANGLE);
934         RNA_def_property_float_sdna(prop, NULL, "limitmin[2]");
935         RNA_def_property_range(prop, -M_PI, 0.0f);
936         RNA_def_property_ui_text(prop, "IK Z Minimum", "Minimum angles for IK Limit");
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_max_z", PROP_FLOAT, PROP_ANGLE);
941         RNA_def_property_float_sdna(prop, NULL, "limitmax[2]");
942         RNA_def_property_range(prop, 0.0f, M_PI);
943         RNA_def_property_ui_text(prop, "IK Z Maximum", "Maximum 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_stiffness_x", PROP_FLOAT, PROP_NONE);
948         RNA_def_property_float_sdna(prop, NULL, "stiffness[0]");
949         RNA_def_property_range(prop, 0.0f, 0.99f);
950         RNA_def_property_ui_text(prop, "IK X Stiffness", "IK stiffness around the X axis");
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_stiffness_y", PROP_FLOAT, PROP_NONE);
955         RNA_def_property_float_sdna(prop, NULL, "stiffness[1]");
956         RNA_def_property_range(prop, 0.0f, 0.99f);
957         RNA_def_property_ui_text(prop, "IK Y Stiffness", "IK stiffness around the Y axis");
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_stiffness_z", PROP_FLOAT, PROP_NONE);
962         RNA_def_property_float_sdna(prop, NULL, "stiffness[2]");
963         RNA_def_property_range(prop, 0.0f, 0.99f);
964         RNA_def_property_ui_text(prop, "IK Z Stiffness", "IK stiffness around the Z axis");
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_stretch", PROP_FLOAT, PROP_NONE);
969         RNA_def_property_float_sdna(prop, NULL, "ikstretch");
970         RNA_def_property_range(prop, 0.0f,1.0f);
971         RNA_def_property_ui_text(prop, "IK Stretch", "Allow scaling of the bone for IK");
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_rotation_weight", PROP_FLOAT, PROP_NONE);
976         RNA_def_property_float_sdna(prop, NULL, "ikrotweight");
977         RNA_def_property_range(prop, 0.0f,1.0f);
978         RNA_def_property_ui_text(prop, "IK Rot Weight", "Weight of rotation constraint for IK");
979         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
980         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
981         
982         prop= RNA_def_property(srna, "ik_linear_weight", PROP_FLOAT, PROP_NONE);
983         RNA_def_property_float_sdna(prop, NULL, "iklinweight");
984         RNA_def_property_range(prop, 0.0f,1.0f);
985         RNA_def_property_ui_text(prop, "IK Lin Weight", "Weight of scale constraint for IK");
986         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
987         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
988         
989         /* custom bone shapes */
990         prop= RNA_def_property(srna, "custom_shape", PROP_POINTER, PROP_NONE);
991         RNA_def_property_pointer_sdna(prop, NULL, "custom");
992         RNA_def_property_struct_type(prop, "Object");
993         RNA_def_property_flag(prop, PROP_EDITABLE);
994         RNA_def_property_pointer_funcs(prop, NULL, "rna_PoseChannel_bone_custom_set", NULL, NULL);
995         RNA_def_property_ui_text(prop, "Custom Object", "Object that defines custom draw type for this bone");
996         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
997         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
998         
999         prop= RNA_def_property(srna, "custom_shape_transform", PROP_POINTER, PROP_NONE);
1000         RNA_def_property_pointer_sdna(prop, NULL, "custom_tx");
1001         RNA_def_property_struct_type(prop, "PoseBone");
1002         RNA_def_property_flag(prop, PROP_EDITABLE);
1003         RNA_def_property_ui_text(prop, "Custom Shape Transform", "Bone that defines the display transform of this custom shape");
1004         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1005         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1006         
1007         /* bone groups */
1008         prop= RNA_def_property(srna, "bone_group_index", PROP_INT, PROP_NONE);
1009         RNA_def_property_int_sdna(prop, NULL, "agrp_index");
1010         RNA_def_property_flag(prop, PROP_EDITABLE);
1011         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
1012         RNA_def_property_int_funcs(prop, "rna_PoseChannel_bone_group_index_get", "rna_PoseChannel_bone_group_index_set", "rna_PoseChannel_bone_group_index_range");
1013         RNA_def_property_ui_text(prop, "Bone Group Index", "Bone Group this pose channel belongs to (0=no group)");
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, "bone_group", PROP_POINTER, PROP_NONE);
1018         RNA_def_property_struct_type(prop, "BoneGroup");
1019         RNA_def_property_flag(prop, PROP_EDITABLE);
1020         RNA_def_property_pointer_funcs(prop, "rna_PoseChannel_bone_group_get", "rna_PoseChannel_bone_group_set", NULL, NULL);
1021         RNA_def_property_ui_text(prop, "Bone Group", "Bone Group this pose channel belongs to");
1022         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1023         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1024         
1025         /* transform locks */
1026         prop= RNA_def_property(srna, "lock_location", PROP_BOOLEAN, PROP_XYZ);
1027         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_LOCX);
1028         RNA_def_property_array(prop, 3);
1029         RNA_def_property_ui_text(prop, "Lock Location", "Lock editing of location in the interface");
1030         RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
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, "lock_rotation", PROP_BOOLEAN, PROP_XYZ);
1035         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTX);
1036         RNA_def_property_array(prop, 3);
1037         RNA_def_property_ui_text(prop, "Lock Rotation", "Lock editing of rotation in the interface");
1038         RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1039         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1040         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1041         
1042                 // XXX this is sub-optimal - it really should be included above, but due to technical reasons we can't do this!
1043         prop= RNA_def_property(srna, "lock_rotation_w", PROP_BOOLEAN, PROP_NONE);
1044         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTW);
1045         RNA_def_property_ui_text(prop, "Lock Rotation (4D Angle)", "Lock editing of 'angle' component of four-component rotations in the interface");
1046         RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1047         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1048         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1049
1050                 // XXX this needs a better name
1051         prop= RNA_def_property(srna, "lock_rotations_4d", PROP_BOOLEAN, PROP_NONE);
1052         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROT4D);
1053         RNA_def_property_ui_text(prop, "Lock Rotations (4D)", "Lock editing of four component rotations by components (instead of as Eulers)");
1054         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1055         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1056
1057         prop= RNA_def_property(srna, "lock_scale", PROP_BOOLEAN, PROP_XYZ);
1058         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_SCALEX);
1059         RNA_def_property_array(prop, 3);
1060         RNA_def_property_ui_text(prop, "Lock Scale", "Lock editing of scale in the interface");
1061         RNA_def_property_ui_icon(prop, ICON_UNLOCKED, 1);
1062         RNA_def_property_editable_func(prop, "rna_PoseChannel_proxy_editable");
1063         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1064
1065         RNA_api_pose_channel(srna);
1066 }
1067
1068 static void rna_def_pose_itasc(BlenderRNA *brna)
1069 {
1070         static const EnumPropertyItem prop_itasc_mode_items[]= {
1071                 {0, "ANIMATION", 0, "Animation", "Stateless solver computing pose starting from current action and non-IK constraints"},
1072                 {ITASC_SIMULATION, "SIMULATION", 0, "Simulation", "Statefull solver running in real-time context and ignoring actions and non-IK constraints"},
1073                 {0, NULL, 0, NULL, NULL}};
1074         static const EnumPropertyItem prop_itasc_reiteration_items[]= {
1075                 {0, "NEVER", 0, "Never", "The solver does not reiterate, not even on first frame (starts from rest pose)"},
1076                 {ITASC_INITIAL_REITERATION, "INITIAL", 0, "Initial", "The solver reiterates (converges) on the first frame but not on subsequent frame"},
1077                 {ITASC_INITIAL_REITERATION|ITASC_REITERATION, "ALWAYS", 0, "Always", "The solver reiterates (converges) on all frames"},
1078                 {0, NULL, 0, NULL, NULL}};
1079
1080         StructRNA *srna;
1081         PropertyRNA *prop;
1082
1083         srna= RNA_def_struct(brna, "Itasc", "IKParam");
1084         RNA_def_struct_sdna(srna, "bItasc");
1085         RNA_def_struct_ui_text(srna, "bItasc", "Parameters for the iTaSC IK solver");
1086
1087         prop= RNA_def_property(srna, "precision", PROP_FLOAT, PROP_NONE);
1088         RNA_def_property_float_sdna(prop, NULL, "precision");
1089         RNA_def_property_range(prop, 0.0f,0.1f);
1090         RNA_def_property_ui_text(prop, "Precision", "Precision of convergence in case of reiteration");
1091         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1092
1093         prop= RNA_def_property(srna, "iterations", PROP_INT, PROP_NONE);
1094         RNA_def_property_int_sdna(prop, NULL, "numiter");
1095         RNA_def_property_range(prop, 1.f,1000.f);
1096         RNA_def_property_ui_text(prop, "Iterations", "Maximum number of iterations for convergence in case of reiteration");
1097         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1098
1099         prop= RNA_def_property(srna, "step_count", PROP_INT, PROP_NONE);
1100         RNA_def_property_int_sdna(prop, NULL, "numstep");
1101         RNA_def_property_range(prop, 1.f, 50.f);
1102         RNA_def_property_ui_text(prop, "Num steps", "Divides the frame interval into this many steps");
1103         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1104
1105         prop= RNA_def_property(srna, "mode", PROP_ENUM, PROP_NONE);
1106         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
1107         RNA_def_property_enum_items(prop, prop_itasc_mode_items);
1108         RNA_def_property_ui_text(prop, "Mode", NULL);
1109         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update_rebuild");
1110
1111         prop= RNA_def_property(srna, "reiteration_method", PROP_ENUM, PROP_NONE);
1112         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
1113         RNA_def_property_enum_items(prop, prop_itasc_reiteration_items);
1114         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");
1115         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1116
1117         prop= RNA_def_property(srna, "use_auto_step", PROP_BOOLEAN, PROP_NONE);
1118         RNA_def_property_boolean_sdna(prop, NULL, "flag", ITASC_AUTO_STEP);
1119         RNA_def_property_ui_text(prop, "Auto step", "Automatically determine the optimal number of steps for best performance/accuracy trade off");
1120         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1121
1122         prop= RNA_def_property(srna, "step_min", PROP_FLOAT, PROP_NONE);
1123         RNA_def_property_float_sdna(prop, NULL, "minstep");
1124         RNA_def_property_range(prop, 0.0f,0.1f);
1125         RNA_def_property_ui_text(prop, "Min step", "Lower bound for timestep in second in case of automatic substeps");
1126         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1127
1128         prop= RNA_def_property(srna, "step_max", PROP_FLOAT, PROP_NONE);
1129         RNA_def_property_float_sdna(prop, NULL, "maxstep");
1130         RNA_def_property_range(prop, 0.0f,1.0f);
1131         RNA_def_property_ui_text(prop, "Max step", "Higher bound for timestep in second in case of automatic substeps");
1132         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1133
1134         prop= RNA_def_property(srna, "feedback", PROP_FLOAT, PROP_NONE);
1135         RNA_def_property_float_sdna(prop, NULL, "feedback");
1136         RNA_def_property_range(prop, 0.0f,100.0f);
1137         RNA_def_property_ui_text(prop, "Feedback", "Feedback coefficient for error correction. Average response time=1/feedback. Default=20");
1138         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1139
1140         prop= RNA_def_property(srna, "velocity_max", PROP_FLOAT, PROP_NONE);
1141         RNA_def_property_float_sdna(prop, NULL, "maxvel");
1142         RNA_def_property_range(prop, 0.0f,100.0f);
1143         RNA_def_property_ui_text(prop, "Max Velocity", "Maximum joint velocity in rad/s. Default=50");
1144         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1145
1146         prop= RNA_def_property(srna, "solver", PROP_ENUM, PROP_NONE);
1147         RNA_def_property_enum_sdna(prop, NULL, "solver");
1148         RNA_def_property_enum_items(prop, prop_solver_items);
1149         RNA_def_property_ui_text(prop, "Solver", "Solving method selection: Automatic damping or manual damping");
1150         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update_rebuild");
1151
1152         prop= RNA_def_property(srna, "damping_max", PROP_FLOAT, PROP_NONE);
1153         RNA_def_property_float_sdna(prop, NULL, "dampmax");
1154         RNA_def_property_range(prop, 0.0f,1.0f);
1155         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");
1156         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1157
1158         prop= RNA_def_property(srna, "damping_epsilon", PROP_FLOAT, PROP_NONE);
1159         RNA_def_property_float_sdna(prop, NULL, "dampeps");
1160         RNA_def_property_range(prop, 0.0f,1.0f);
1161         RNA_def_property_ui_text(prop, "Epsilon", "Singular value under which damping is progressively applied. Higher values=more stability, less reactivity. Default=0.1");
1162         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Itasc_update");
1163 }
1164
1165 static void rna_def_pose_ikparam(BlenderRNA *brna)
1166 {
1167         StructRNA *srna;
1168         PropertyRNA *prop;
1169
1170         srna= RNA_def_struct(brna, "IKParam", NULL);
1171         RNA_def_struct_sdna(srna, "bIKParam");
1172         RNA_def_struct_ui_text(srna, "IKParam", "Base type for IK solver parameters");
1173         RNA_def_struct_refine_func(srna, "rna_IKParam_refine");
1174
1175         prop= RNA_def_property(srna, "ik_solver", PROP_ENUM, PROP_NONE);
1176         RNA_def_property_enum_sdna(prop, NULL, "iksolver");
1177         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1178         RNA_def_property_enum_items(prop, prop_iksolver_items);
1179         RNA_def_property_ui_text(prop, "IK Solver", "IK solver for which these parameters are defined, 0 for Legacy, 1 for iTaSC");
1180 }
1181
1182 /* pose.bone_groups */
1183 static void rna_def_bone_groups(BlenderRNA *brna, PropertyRNA *cprop)
1184 {
1185         StructRNA *srna;
1186         PropertyRNA *prop;
1187
1188 //      FunctionRNA *func;
1189 //      PropertyRNA *parm;
1190
1191         RNA_def_property_srna(cprop, "BoneGroups");
1192         srna= RNA_def_struct(brna, "BoneGroups", NULL);
1193         RNA_def_struct_sdna(srna, "bPose");
1194         RNA_def_struct_ui_text(srna, "Bone Groups", "Collection of bone groups");
1195
1196         prop= RNA_def_property(srna, "active", PROP_POINTER, PROP_NONE);
1197         RNA_def_property_struct_type(prop, "BoneGroup");
1198         RNA_def_property_flag(prop, PROP_EDITABLE);
1199         RNA_def_property_pointer_funcs(prop, "rna_Pose_active_bone_group_get", "rna_Pose_active_bone_group_set", NULL, NULL);
1200         RNA_def_property_ui_text(prop, "Active Bone Group", "Active bone group for this pose");
1201         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1202         
1203         prop= RNA_def_property(srna, "active_index", PROP_INT, PROP_NONE);
1204         RNA_def_property_int_sdna(prop, NULL, "active_group");
1205         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");
1206         RNA_def_property_ui_text(prop, "Active Bone Group Index", "Active index in bone groups array");
1207         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
1208 }
1209
1210 static void rna_def_pose(BlenderRNA *brna)
1211 {
1212         StructRNA *srna;
1213         PropertyRNA *prop;
1214         
1215         /* struct definition */
1216         srna= RNA_def_struct(brna, "Pose", NULL);
1217         RNA_def_struct_sdna(srna, "bPose");
1218         RNA_def_struct_ui_text(srna, "Pose", "A collection of pose channels, including settings for animating bones");
1219
1220         /* pose channels */
1221         prop= RNA_def_property(srna, "bones", PROP_COLLECTION, PROP_NONE);
1222         RNA_def_property_collection_sdna(prop, NULL, "chanbase", NULL);
1223         RNA_def_property_struct_type(prop, "PoseBone");
1224         RNA_def_property_ui_text(prop, "Pose Bones", "Individual pose bones for the armature");
1225         RNA_def_property_collection_funcs(prop, NULL, NULL, NULL, NULL, NULL, NULL, "rna_PoseBones_lookup_string"); /* can be removed, only for fast lookup */
1226         /* bone groups */
1227         prop= RNA_def_property(srna, "bone_groups", PROP_COLLECTION, PROP_NONE);
1228         RNA_def_property_collection_sdna(prop, NULL, "agroups", NULL);
1229         RNA_def_property_struct_type(prop, "BoneGroup");
1230         RNA_def_property_ui_text(prop, "Bone Groups", "Groups of the bones");
1231         rna_def_bone_groups(brna, prop);
1232         
1233         /* ik solvers */
1234         prop= RNA_def_property(srna, "ik_solver", PROP_ENUM, PROP_NONE);
1235         RNA_def_property_enum_sdna(prop, NULL, "iksolver");
1236         RNA_def_property_enum_funcs(prop, NULL, "rna_Pose_ik_solver_set", NULL);
1237         RNA_def_property_enum_items(prop, prop_iksolver_items);
1238         RNA_def_property_ui_text(prop, "IK Solver", "Selection of IK solver for IK chain, current choice is 0 for Legacy, 1 for iTaSC");
1239         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_ik_solver_update");
1240
1241         prop= RNA_def_property(srna, "ik_param", PROP_POINTER, PROP_NONE);
1242         RNA_def_property_struct_type(prop, "IKParam");
1243         RNA_def_property_pointer_funcs(prop, "rna_Pose_ikparam_get", NULL, "rna_Pose_ikparam_typef", NULL);
1244         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
1245         RNA_def_property_ui_text(prop, "IK Param", "Parameters for IK solver");
1246         
1247         /* animviz */
1248         rna_def_animviz_common(srna);
1249         
1250         /* RNA_api_pose(srna); */
1251 }
1252
1253 void RNA_def_pose(BlenderRNA *brna)
1254 {
1255         rna_def_pose(brna);
1256         rna_def_pose_channel(brna);
1257         rna_def_pose_ikparam(brna);
1258         rna_def_pose_itasc(brna);
1259         rna_def_bone_group(brna);
1260 }
1261
1262 #endif