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