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