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