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