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