3a03e7a624de5b3ab8a73ed791c69b9368c0100d
[blender.git] / source / blender / makesrna / intern / rna_pose.c
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * Contributor(s): Blender Foundation (2008), Roland Hess, Joshua Leung
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 #include <stdlib.h>
26
27 #include "RNA_define.h"
28 #include "RNA_types.h"
29
30 #include "rna_internal.h"
31
32 #include "DNA_action_types.h"
33 #include "DNA_armature_types.h"
34 #include "DNA_constraint_types.h"
35 #include "DNA_object_types.h"
36 #include "DNA_scene_types.h"
37
38 #include "WM_types.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include <string.h>
43
44 #include "BLI_arithb.h"
45
46 #include "DNA_userdef_types.h"
47
48 #include "BKE_context.h"
49 #include "BKE_depsgraph.h"
50 #include "BKE_idprop.h"
51
52 #include "ED_armature.h"
53
54 static void rna_Pose_update(bContext *C, PointerRNA *ptr)
55 {
56         // XXX when to use this? ob->pose->flag |= (POSE_LOCKED|POSE_DO_UNLOCK);
57
58         DAG_id_flush_update(ptr->id.data, OB_RECALC_DATA);
59 }
60
61 static char *rna_PoseChannel_path(PointerRNA *ptr)
62 {
63         return BLI_sprintfN("pose.pose_channels[\"%s\"]", ((bPoseChannel*)ptr->data)->name);
64 }
65
66 static void rna_BoneGroup_color_set_set(PointerRNA *ptr, int value)
67 {
68         bActionGroup *grp= ptr->data;
69         
70         /* if valid value, set the new enum value, then copy the relevant colours? */
71         if ((value >= -1) && (value < 21))
72                 grp->customCol= value;
73         else
74                 return;
75         
76         /* only do color copying if using a custom color (i.e. not default colour)  */
77         if (grp->customCol) {
78                 if (grp->customCol > 0) {
79                         /* copy theme colors on-to group's custom color in case user tries to edit color */
80                         bTheme *btheme= U.themes.first;
81                         ThemeWireColor *col_set= &btheme->tarm[(grp->customCol - 1)];
82                         
83                         memcpy(&grp->cs, col_set, sizeof(ThemeWireColor));
84                 }
85                 else {
86                         /* init custom colors with a generic multi-color rgb set, if not initialised already (for custom color set) */
87                         if (grp->cs.solid[0] == 0) {
88                                 /* define for setting colors in theme below */
89                                 #define SETCOL(col, r, g, b, a)  col[0]=r; col[1]=g; col[2]= b; col[3]= a;
90                                 
91                                 SETCOL(grp->cs.solid, 0xff, 0x00, 0x00, 255);
92                                 SETCOL(grp->cs.select, 0x81, 0xe6, 0x14, 255);
93                                 SETCOL(grp->cs.active, 0x18, 0xb6, 0xe0, 255);
94                                 
95                                 #undef SETCOL
96                         }
97                 }
98         }
99 }
100
101 IDProperty *rna_PoseChannel_idproperties(PointerRNA *ptr, int create)
102 {
103         bPoseChannel *pchan= ptr->data;
104
105         if(create && !pchan->prop) {
106                 IDPropertyTemplate val = {0};
107                 pchan->prop= IDP_New(IDP_GROUP, val, "RNA_PoseChannel group");
108         }
109
110         return pchan->prop;
111 }
112
113 /* rotation - euler angles */
114 static void rna_PoseChannel_euler_rotation_get(PointerRNA *ptr, float *value)
115 {
116         bPoseChannel *pchan= ptr->data;
117         
118         if(pchan->rotmode == PCHAN_ROT_AXISANGLE) /* default XYZ eulers */
119                 AxisAngleToEulO(&pchan->quat[1], pchan->quat[0], value, EULER_ORDER_DEFAULT);
120         else if(pchan->rotmode == PCHAN_ROT_QUAT) /* default XYZ eulers  */
121                 QuatToEul(pchan->quat, value);
122         else
123                 VECCOPY(value, pchan->eul);
124 }
125
126 /* rotation - euler angles */
127 static void rna_PoseChannel_euler_rotation_set(PointerRNA *ptr, const float *value)
128 {
129         bPoseChannel *pchan= ptr->data;
130         
131         if(pchan->rotmode == PCHAN_ROT_AXISANGLE) /* default XYZ eulers */
132                 EulOToAxisAngle((float *)value, EULER_ORDER_DEFAULT, &pchan->quat[1], &pchan->quat[0]);
133         else if(pchan->rotmode == PCHAN_ROT_QUAT) /* default XYZ eulers */
134                 EulToQuat((float*)value, pchan->quat);
135         else
136                 VECCOPY(pchan->eul, value);
137 }
138
139 /* rotation - axis angle only */
140 static void rna_PoseChannel_rotation_axis_get(PointerRNA *ptr, float *value)
141 {
142         bPoseChannel *pchan= ptr->data;
143         
144         if (pchan->rotmode == PCHAN_ROT_AXISANGLE) {
145                 /* axis is stord in quat for now */
146                 VecCopyf(value, &pchan->quat[1]);
147         }
148 }
149
150 /* rotation - axis angle only */
151 static void rna_PoseChannel_rotation_axis_set(PointerRNA *ptr, const float *value)
152 {
153         bPoseChannel *pchan= ptr->data;
154         
155         if (pchan->rotmode == PCHAN_ROT_AXISANGLE) {
156                 /* axis is stored in quat for now */
157                 VecCopyf(&pchan->quat[1], (float *)value);
158         }
159 }
160
161 static void rna_PoseChannel_rotation_mode_set(PointerRNA *ptr, int value)
162 {
163         bPoseChannel *pchan= ptr->data;
164         
165         /* check if any change - if so, need to convert data */
166         // TODO: this needs to be generalised at some point to work for objects too...
167         if (value > 0) { /* to euler */
168                 if (pchan->rotmode == PCHAN_ROT_AXISANGLE) {
169                         /* axis-angle to euler */
170                         AxisAngleToEulO(&pchan->quat[1], pchan->quat[0], pchan->eul, value);
171                 }
172                 else if (pchan->rotmode == PCHAN_ROT_QUAT) {
173                         /* quat to euler */
174                         QuatToEulO(pchan->quat, pchan->eul, value);
175                 }
176                 /* else { no conversion needed } */
177         }
178         else if (value == PCHAN_ROT_QUAT) { /* to quat */
179                 if (pchan->rotmode == PCHAN_ROT_AXISANGLE) {
180                         /* axis angle to quat */
181                         float q[4];
182                         
183                         /* copy to temp var first, since quats and axis-angle are stored in same place */
184                         QuatCopy(q, pchan->quat);
185                         AxisAngleToQuat(q, &pchan->quat[1], pchan->quat[0]);
186                 }
187                 else if (pchan->rotmode > 0) {
188                         /* euler to quat */
189                         EulOToQuat(pchan->eul, pchan->rotmode, pchan->quat);
190                 }
191                 /* else { no conversion needed } */
192         }
193         else { /* to axis-angle */
194                 if (pchan->rotmode > 0) {
195                         /* euler to axis angle */
196                         EulOToAxisAngle(pchan->eul, pchan->rotmode, &pchan->quat[1], &pchan->quat[0]);
197                 }
198                 else if (pchan->rotmode == PCHAN_ROT_QUAT) {
199                         /* quat to axis angle */
200                         float q[4];
201                         
202                         /* copy to temp var first, since quats and axis-angle are stored in same place */
203                         QuatCopy(q, pchan->quat);
204                         QuatToAxisAngle(q, &pchan->quat[1], &pchan->quat[0]);
205                 }
206                 
207                 /* when converting to axis-angle, we need a special exception for the case when there is no axis */
208                 if (IS_EQ(pchan->quat[1], pchan->quat[2]) && IS_EQ(pchan->quat[2], pchan->quat[3])) {
209                         /* for now, rotate around y-axis then (so that it simply becomes the roll) */
210                         pchan->quat[2]= 1.0f;
211                 }
212         }
213         
214         /* finally, set the new rotation type */
215         pchan->rotmode= value;
216 }
217
218 static void rna_PoseChannel_name_set(PointerRNA *ptr, const char *value)
219 {
220         Object *ob= (Object*)ptr->id.data;
221         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
222         char oldname[32], newname[32];
223         
224         /* need to be on the stack */
225         BLI_strncpy(newname, value, 32);
226         BLI_strncpy(oldname, pchan->name, 32);
227         
228         ED_armature_bone_rename(ob->data, oldname, newname);
229 }
230
231 static int rna_PoseChannel_has_ik_get(PointerRNA *ptr)
232 {
233         Object *ob= (Object*)ptr->id.data;
234         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
235
236         return ED_pose_channel_in_IK_chain(ob, pchan);
237 }
238
239 static PointerRNA rna_PoseChannel_bone_group_get(PointerRNA *ptr)
240 {
241         Object *ob= (Object*)ptr->id.data;
242         bPose *pose= (ob) ? ob->pose : NULL;
243         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
244         bActionGroup *grp;
245         
246         if (pose)
247                 grp= BLI_findlink(&pose->agroups, pchan->agrp_index-1);
248         else
249                 grp= NULL;
250         
251         return rna_pointer_inherit_refine(ptr, &RNA_BoneGroup, grp);
252 }
253
254 static void rna_PoseChannel_bone_group_set(PointerRNA *ptr, PointerRNA value)
255 {
256         Object *ob= (Object*)ptr->id.data;
257         bPose *pose= (ob) ? ob->pose : NULL;
258         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
259         
260         if (pose)
261                 pchan->agrp_index= BLI_findindex(&pose->agroups, value.data) + 1;
262         else
263                 pchan->agrp_index= 0;
264 }
265
266 static int rna_PoseChannel_bone_group_index_get(PointerRNA *ptr)
267 {
268         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
269         return MAX2(pchan->agrp_index-1, 0);
270 }
271
272 static void rna_PoseChannel_bone_group_index_set(PointerRNA *ptr, int value)
273 {
274         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
275         pchan->agrp_index= value+1;
276 }
277
278 static void rna_PoseChannel_bone_group_index_range(PointerRNA *ptr, int *min, int *max)
279 {
280         Object *ob= (Object*)ptr->id.data;
281         bPose *pose= (ob) ? ob->pose : NULL;
282         
283         *min= 0;
284         
285         if (pose) {
286                 *max= BLI_countlist(&pose->agroups)-1;
287                 *max= MAX2(0, *max);
288         }
289         else
290                 *max= 0;
291 }
292
293 static PointerRNA rna_Pose_active_bone_group_get(PointerRNA *ptr)
294 {
295         bPose *pose= (bPose*)ptr->data;
296         return rna_pointer_inherit_refine(ptr, &RNA_BoneGroup, BLI_findlink(&pose->agroups, pose->active_group-1));
297 }
298
299 static void rna_Pose_active_bone_group_set(PointerRNA *ptr, PointerRNA value)
300 {
301         bPose *pose= (bPose*)ptr->data;
302         pose->active_group= BLI_findindex(&pose->agroups, value.data) + 1;
303 }
304
305 static int rna_Pose_active_bone_group_index_get(PointerRNA *ptr)
306 {
307         bPose *pose= (bPose*)ptr->data;
308         return MAX2(pose->active_group-1, 0);
309 }
310
311 static void rna_Pose_active_bone_group_index_set(PointerRNA *ptr, int value)
312 {
313         bPose *pose= (bPose*)ptr->data;
314         pose->active_group= value+1;
315 }
316
317 static void rna_Pose_active_bone_group_index_range(PointerRNA *ptr, int *min, int *max)
318 {
319         bPose *pose= (bPose*)ptr->data;
320
321         *min= 0;
322         *max= BLI_countlist(&pose->agroups)-1;
323         *max= MAX2(0, *max);
324 }
325
326 void rna_pose_bgroup_name_index_get(PointerRNA *ptr, char *value, int index)
327 {
328         bPose *pose= (bPose*)ptr->data;
329         bActionGroup *grp;
330
331         grp= BLI_findlink(&pose->agroups, index-1);
332
333         if(grp) BLI_strncpy(value, grp->name, sizeof(grp->name));
334         else BLI_strncpy(value, "", sizeof(grp->name)); // XXX if invalid pointer, won't this crash?
335 }
336
337 int rna_pose_bgroup_name_index_length(PointerRNA *ptr, int index)
338 {
339         bPose *pose= (bPose*)ptr->data;
340         bActionGroup *grp;
341
342         grp= BLI_findlink(&pose->agroups, index-1);
343         return (grp)? strlen(grp->name): 0;
344 }
345
346 void rna_pose_bgroup_name_index_set(PointerRNA *ptr, const char *value, short *index)
347 {
348         bPose *pose= (bPose*)ptr->data;
349         bActionGroup *grp;
350         int a;
351         
352         for (a=1, grp=pose->agroups.first; grp; grp=grp->next, a++) {
353                 if (strcmp(grp->name, value) == 0) {
354                         *index= a;
355                         return;
356                 }
357         }
358         
359         *index= 0;
360 }
361
362 void rna_pose_pgroup_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
363 {
364         bPose *pose= (bPose*)ptr->data;
365         bActionGroup *grp;
366         
367         for (grp= pose->agroups.first; grp; grp= grp->next) {
368                 if (strcmp(grp->name, value) == 0) {
369                         BLI_strncpy(result, value, maxlen);
370                         return;
371                 }
372         }
373         
374         BLI_strncpy(result, "", maxlen);
375 }
376
377 #else
378
379 static void rna_def_bone_group(BlenderRNA *brna)
380 {
381         static EnumPropertyItem prop_colorSets_items[] = {
382                 {0, "DEFAULT", 0, "Default Colors", ""},
383                 {1, "THEME01", 0, "01 - Theme Color Set", ""},
384                 {2, "THEME02", 0, "02 - Theme Color Set", ""},
385                 {3, "THEME03", 0, "03 - Theme Color Set", ""},
386                 {4, "THEME04", 0, "04 - Theme Color Set", ""},
387                 {5, "THEME05", 0, "05 - Theme Color Set", ""},
388                 {6, "THEME06", 0, "06 - Theme Color Set", ""},
389                 {7, "THEME07", 0, "07 - Theme Color Set", ""},
390                 {8, "THEME08", 0, "08 - Theme Color Set", ""},
391                 {9, "THEME09", 0, "09 - Theme Color Set", ""},
392                 {10, "THEME10", 0, "10 - Theme Color Set", ""},
393                 {11, "THEME11", 0, "11 - Theme Color Set", ""},
394                 {12, "THEME12", 0, "12 - Theme Color Set", ""},
395                 {13, "THEME13", 0, "13 - Theme Color Set", ""},
396                 {14, "THEME14", 0, "14 - Theme Color Set", ""},
397                 {15, "THEME15", 0, "15 - Theme Color Set", ""},
398                 {16, "THEME16", 0, "16 - Theme Color Set", ""},
399                 {17, "THEME17", 0, "17 - Theme Color Set", ""},
400                 {18, "THEME18", 0, "18 - Theme Color Set", ""},
401                 {19, "THEME19", 0, "19 - Theme Color Set", ""},
402                 {20, "THEME20", 0, "20 - Theme Color Set", ""},
403                 {-1, "CUSTOM", 0, "Custom Color Set", ""},
404                 {0, NULL, 0, NULL, NULL}};
405         
406         StructRNA *srna;
407         PropertyRNA *prop;
408         
409         /* struct */
410         srna= RNA_def_struct(brna, "BoneGroup", NULL);
411         RNA_def_struct_sdna(srna, "bActionGroup");
412         RNA_def_struct_ui_text(srna, "Bone Group", "Groups of Pose Channels (Bones).");
413         RNA_def_struct_ui_icon(srna, ICON_GROUP_BONE);
414         
415         /* name */
416         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
417         RNA_def_property_ui_text(prop, "Name", "");
418         RNA_def_struct_name_property(srna, prop);
419         
420         // TODO: add some runtime-collections stuff to access grouped bones 
421         
422         /* color set + colors */
423         prop= RNA_def_property(srna, "color_set", PROP_ENUM, PROP_NONE);
424         RNA_def_property_enum_sdna(prop, NULL, "customCol");
425         RNA_def_property_enum_items(prop, prop_colorSets_items);
426         RNA_def_property_enum_funcs(prop, NULL, "rna_BoneGroup_color_set_set", NULL);
427         RNA_def_property_ui_text(prop, "Color Set", "Custom color set to use.");
428         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
429         
430                 // TODO: editing the colors for this should result in changes to the color type...
431         prop= RNA_def_property(srna, "colors", PROP_POINTER, PROP_NEVER_NULL);
432         RNA_def_property_struct_type(prop, "ThemeBoneColorSet");
433         RNA_def_property_pointer_sdna(prop, NULL, "cs"); /* NOTE: the DNA data is not really a pointer, but this code works :) */
434         RNA_def_property_ui_text(prop, "Colors", "Copy of the colors associated with the group's color set.");
435         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
436 }
437
438 static void rna_def_pose_channel(BlenderRNA *brna)
439 {
440         static EnumPropertyItem prop_rotmode_items[] = {
441                 {PCHAN_ROT_QUAT, "QUATERNION", 0, "Quaternion (WXYZ)", "No Gimbal Lock (default)"},
442                 {PCHAN_ROT_XYZ, "XYZ", 0, "XYZ Euler", "XYZ Rotation Order. Prone to Gimbal Lock"},
443                 {PCHAN_ROT_XZY, "XZY", 0, "XZY Euler", "XZY Rotation Order. Prone to Gimbal Lock"},
444                 {PCHAN_ROT_YXZ, "YXZ", 0, "YXZ Euler", "YXZ Rotation Order. Prone to Gimbal Lock"},
445                 {PCHAN_ROT_YZX, "YZX", 0, "YZX Euler", "YZX Rotation Order. Prone to Gimbal Lock"},
446                 {PCHAN_ROT_ZXY, "ZXY", 0, "ZXY Euler", "ZXY Rotation Order. Prone to Gimbal Lock"},
447                 {PCHAN_ROT_ZYX, "ZYX", 0, "ZYX Euler", "ZYX Rotation Order. Prone to Gimbal Lock"},
448                 {PCHAN_ROT_AXISANGLE, "AXIS_ANGLE", 0, "Axis Angle", "Axis Angle (W+XYZ). Defines a rotation around some axis defined by 3D-Vector."},
449                 {0, NULL, 0, NULL, NULL}};
450         
451         StructRNA *srna;
452         PropertyRNA *prop;
453
454         srna= RNA_def_struct(brna, "PoseChannel", NULL);
455         RNA_def_struct_sdna(srna, "bPoseChannel");
456         RNA_def_struct_ui_text(srna, "Pose Channel", "Channel defining pose data for a bone in a Pose.");
457         RNA_def_struct_path_func(srna, "rna_PoseChannel_path");
458         RNA_def_struct_idproperties_func(srna, "rna_PoseChannel_idproperties");
459         
460         /* Bone Constraints */
461         prop= RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
462         RNA_def_property_struct_type(prop, "Constraint");
463         RNA_def_property_ui_text(prop, "Constraints", "Constraints that act on this PoseChannel."); 
464
465         /* Name + Selection Status */
466         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
467         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_PoseChannel_name_set");
468         RNA_def_property_ui_text(prop, "Name", "");
469         RNA_def_struct_name_property(srna, prop);
470         
471         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
472         RNA_def_property_boolean_sdna(prop, NULL, "selectflag", BONE_SELECTED);
473         RNA_def_property_ui_text(prop, "Selected", "");
474
475         /* Baked Bone Path cache data s*/
476         prop= RNA_def_property(srna, "path_start_frame", PROP_INT, PROP_TIME);
477         RNA_def_property_int_sdna(prop, NULL, "pathsf");
478         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
479         RNA_def_property_ui_text(prop, "Bone Paths Calculation Start Frame", "Starting frame of range of frames to use for Bone Path calculations.");
480         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
481
482         prop= RNA_def_property(srna, "path_end_frame", PROP_INT, PROP_TIME);
483         RNA_def_property_int_sdna(prop, NULL, "pathef");
484         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
485         RNA_def_property_ui_text(prop, "Bone Paths Calculation End Frame", "End frame of range of frames to use for Bone Path calculations.");
486         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
487         
488         /* Relationships to other bones */
489         prop= RNA_def_property(srna, "bone", PROP_POINTER, PROP_NEVER_NULL);
490         RNA_def_property_struct_type(prop, "Bone");
491         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
492         RNA_def_property_ui_text(prop, "Bone", "Bone associated with this Pose Channel.");
493
494         prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
495         RNA_def_property_struct_type(prop, "PoseChannel");
496         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
497         RNA_def_property_ui_text(prop, "Parent", "Parent of this pose channel.");
498
499         prop= RNA_def_property(srna, "child", PROP_POINTER, PROP_NONE);
500         RNA_def_property_struct_type(prop, "PoseChannel");
501         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
502         RNA_def_property_ui_text(prop, "Child", "Child of this pose channel.");
503         
504         /* Transformation settings */
505         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_TRANSLATION);
506         RNA_def_property_float_sdna(prop, NULL, "loc");
507         RNA_def_property_ui_text(prop, "Location", "");
508         RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Pose_update");
509
510         prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);
511         RNA_def_property_float_sdna(prop, NULL, "size");
512         RNA_def_property_ui_text(prop, "Scale", "");
513         RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Pose_update");
514
515         prop= RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_QUATERNION);
516         RNA_def_property_float_sdna(prop, NULL, "quat");
517         RNA_def_property_ui_text(prop, "Rotation", "Rotation in Quaternions.");
518         RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Pose_update");
519         
520         prop= RNA_def_property(srna, "rotation_angle", PROP_FLOAT, PROP_NONE);
521         RNA_def_property_float_sdna(prop, NULL, "quat[0]");
522         RNA_def_property_ui_text(prop, "Rotation Angle", "Angle of Rotation for Axis-Angle rotation representation.");
523         RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Pose_update");
524         
525         prop= RNA_def_property(srna, "rotation_axis", PROP_FLOAT, PROP_XYZ);
526         RNA_def_property_float_sdna(prop, NULL, "quat");
527         RNA_def_property_float_funcs(prop, "rna_PoseChannel_rotation_axis_get", "rna_PoseChannel_rotation_axis_set", NULL);
528         RNA_def_property_array(prop, 3);
529         RNA_def_property_ui_text(prop, "Rotation Axis", "Axis for Axis-Angle rotation representation.");
530         RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Pose_update");
531         
532         prop= RNA_def_property(srna, "euler_rotation", PROP_FLOAT, PROP_EULER);
533         RNA_def_property_float_sdna(prop, NULL, "eul");
534         RNA_def_property_float_funcs(prop, "rna_PoseChannel_euler_rotation_get", "rna_PoseChannel_euler_rotation_set", NULL);
535         RNA_def_property_ui_text(prop, "Rotation (Euler)", "Rotation in Eulers.");
536         RNA_def_property_update(prop, NC_OBJECT|ND_TRANSFORM, "rna_Pose_update");
537         
538         prop= RNA_def_property(srna, "rotation_mode", PROP_ENUM, PROP_NONE);
539         RNA_def_property_enum_sdna(prop, NULL, "rotmode");
540         RNA_def_property_enum_items(prop, prop_rotmode_items);
541         RNA_def_property_enum_funcs(prop, NULL, "rna_PoseChannel_rotation_mode_set", NULL);
542         RNA_def_property_ui_text(prop, "Rotation Mode", "");
543         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
544
545         /* These three matrix properties await an implementation of the PROP_MATRIX subtype, which currently doesn't exist. */
546 /*      prop= RNA_def_property(srna, "channel_matrix", PROP_FLOAT, PROP_MATRIX);
547         RNA_def_property_struct_type(prop, "chan_mat");
548         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
549         RNA_def_property_ui_text(prop, "Channel Matrix", "4x4 matrix, before constraints.");*/
550
551         /* kaito says this should be not user-editable; I disagree; power users should be able to force this in python; he's the boss. */
552 /*      prop= RNA_def_property(srna, "pose_matrix", PROP_FLOAT, PROP_MATRIX);
553         RNA_def_property_struct_type(prop, "pose_mat");
554         RNA_def_property_clear_flag(prop, PROP_EDITABLE); 
555         RNA_def_property_ui_text(prop, "Pose Matrix", "Final 4x4 matrix for this channel.");
556
557         prop= RNA_def_property(srna, "constraint_inverse_matrix", PROP_FLOAT, PROP_MATRIX);
558         RNA_def_property_struct_type(prop, "constinv");
559         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
560         RNA_def_property_ui_text(prop, "Constraint Inverse Matrix", "4x4 matrix, defines transform from final position to unconstrained position."); */
561         
562         /* Head/Tail Coordinates (in Pose Space) - Automatically calculated... */
563         prop= RNA_def_property(srna, "pose_head", PROP_FLOAT, PROP_TRANSLATION);
564         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
565         RNA_def_property_ui_text(prop, "Pose Head Position", "Location of head of the channel's bone.");
566
567         prop= RNA_def_property(srna, "pose_tail", PROP_FLOAT, PROP_TRANSLATION);
568         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
569         RNA_def_property_ui_text(prop, "Pose Tail Position", "Location of tail of the channel's bone.");
570         
571         /* IK Settings */
572         prop= RNA_def_property(srna, "has_ik", PROP_BOOLEAN, PROP_NONE);
573         RNA_def_property_boolean_funcs(prop,  "rna_PoseChannel_has_ik_get", NULL);
574         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
575         RNA_def_property_ui_text(prop, "Has IK", "Is part of an IK chain.");
576         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
577
578         prop= RNA_def_property(srna, "ik_dof_x", PROP_BOOLEAN, PROP_NONE);
579         RNA_def_property_boolean_negative_sdna(prop, NULL, "ikflag", BONE_IK_NO_XDOF);
580         RNA_def_property_ui_text(prop, "IK X DoF", "Allow movement around the X axis.");
581         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
582
583         prop= RNA_def_property(srna, "ik_dof_y", PROP_BOOLEAN, PROP_NONE);
584         RNA_def_property_boolean_negative_sdna(prop, NULL, "ikflag", BONE_IK_NO_YDOF);
585         RNA_def_property_ui_text(prop, "IK Y DoF", "Allow movement around the Y axis.");
586         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
587
588         prop= RNA_def_property(srna, "ik_dof_z", PROP_BOOLEAN, PROP_NONE);
589         RNA_def_property_boolean_negative_sdna(prop, NULL, "ikflag", BONE_IK_NO_ZDOF);
590         RNA_def_property_ui_text(prop, "IK Z DoF", "Allow movement around the Z axis.");
591         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
592
593         prop= RNA_def_property(srna, "ik_limit_x", PROP_BOOLEAN, PROP_NONE);
594         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_XLIMIT);
595         RNA_def_property_ui_text(prop, "IK X Limit", "Limit movement around the X axis.");
596         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
597
598         prop= RNA_def_property(srna, "ik_limit_y", PROP_BOOLEAN, PROP_NONE);
599         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_YLIMIT);
600         RNA_def_property_ui_text(prop, "IK Y Limit", "Limit movement around the Y axis.");
601         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
602
603         prop= RNA_def_property(srna, "ik_limit_z", PROP_BOOLEAN, PROP_NONE);
604         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ZLIMIT);
605         RNA_def_property_ui_text(prop, "IK Z Limit", "Limit movement around the Z axis.");
606         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
607         
608         prop= RNA_def_property(srna, "ik_min_x", PROP_FLOAT, PROP_ANGLE);
609         RNA_def_property_float_sdna(prop, NULL, "limitmin[0]");
610         RNA_def_property_range(prop, -180.0f, 0.0f);
611         RNA_def_property_ui_text(prop, "IK X Minimum", "Minimum angles for IK Limit");
612         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
613
614         prop= RNA_def_property(srna, "ik_max_x", PROP_FLOAT, PROP_ANGLE);
615         RNA_def_property_float_sdna(prop, NULL, "limitmax[0]");
616         RNA_def_property_range(prop, 0.0f, 180.0f);
617         RNA_def_property_ui_text(prop, "IK X Maximum", "Maximum angles for IK Limit");
618         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
619
620         prop= RNA_def_property(srna, "ik_min_y", PROP_FLOAT, PROP_ANGLE);
621         RNA_def_property_float_sdna(prop, NULL, "limitmin[1]");
622         RNA_def_property_range(prop, -180.0f, 0.0f);
623         RNA_def_property_ui_text(prop, "IK Y Minimum", "Minimum angles for IK Limit");
624         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
625
626         prop= RNA_def_property(srna, "ik_max_y", PROP_FLOAT, PROP_ANGLE);
627         RNA_def_property_float_sdna(prop, NULL, "limitmax[1]");
628         RNA_def_property_range(prop, 0.0f, 180.0f);
629         RNA_def_property_ui_text(prop, "IK Y Maximum", "Maximum angles for IK Limit");
630         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
631
632         prop= RNA_def_property(srna, "ik_min_z", PROP_FLOAT, PROP_ANGLE);
633         RNA_def_property_float_sdna(prop, NULL, "limitmin[2]");
634         RNA_def_property_range(prop, -180.0f, 0.0f);
635         RNA_def_property_ui_text(prop, "IK Z Minimum", "Minimum angles for IK Limit");
636         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
637
638         prop= RNA_def_property(srna, "ik_max_z", PROP_FLOAT, PROP_ANGLE);
639         RNA_def_property_float_sdna(prop, NULL, "limitmax[2]");
640         RNA_def_property_range(prop, 0.0f, 180.0f);
641         RNA_def_property_ui_text(prop, "IK Z Maximum", "Maximum angles for IK Limit");
642         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
643
644         prop= RNA_def_property(srna, "ik_stiffness_x", PROP_FLOAT, PROP_NONE);
645         RNA_def_property_float_sdna(prop, NULL, "stiffness[0]");
646         RNA_def_property_range(prop, 0.0f, 0.99f);
647         RNA_def_property_ui_text(prop, "IK X Stiffness", "IK stiffness around the X axis.");
648         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
649
650         prop= RNA_def_property(srna, "ik_stiffness_y", PROP_FLOAT, PROP_NONE);
651         RNA_def_property_float_sdna(prop, NULL, "stiffness[1]");
652         RNA_def_property_range(prop, 0.0f, 0.99f);
653         RNA_def_property_ui_text(prop, "IK Y Stiffness", "IK stiffness around the Y axis.");
654         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
655
656         prop= RNA_def_property(srna, "ik_stiffness_z", PROP_FLOAT, PROP_NONE);
657         RNA_def_property_float_sdna(prop, NULL, "stiffness[2]");
658         RNA_def_property_range(prop, 0.0f, 0.99f);
659         RNA_def_property_ui_text(prop, "IK Z Stiffness", "IK stiffness around the Z axis.");
660         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
661
662         prop= RNA_def_property(srna, "ik_stretch", PROP_FLOAT, PROP_NONE);
663         RNA_def_property_float_sdna(prop, NULL, "ikstretch");
664         RNA_def_property_range(prop, 0.0f,1.0f);
665         RNA_def_property_ui_text(prop, "IK Stretch", "Allow scaling of the bone for IK.");
666         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
667         
668         /* custom bone shapes */
669         prop= RNA_def_property(srna, "custom_shape", PROP_POINTER, PROP_NONE);
670         RNA_def_property_pointer_sdna(prop, NULL, "custom");
671         RNA_def_property_struct_type(prop, "Object");
672         RNA_def_property_flag(prop, PROP_EDITABLE);
673         RNA_def_property_ui_text(prop, "Custom Object", "Object that defines custom draw type for this bone.");
674         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
675         
676         /* bone groups */
677         prop= RNA_def_property(srna, "bone_group_index", PROP_INT, PROP_NONE);
678         RNA_def_property_int_sdna(prop, NULL, "agrp_index");
679         RNA_def_property_flag(prop, PROP_EDITABLE);
680         RNA_def_property_int_funcs(prop, "rna_PoseChannel_bone_group_index_get", "rna_PoseChannel_bone_group_index_set", "rna_PoseChannel_bone_group_index_range");
681         RNA_def_property_ui_text(prop, "Bone Group Index", "Bone Group this pose channel belongs to (0=no group).");
682         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
683         
684         prop= RNA_def_property(srna, "bone_group", PROP_POINTER, PROP_NONE);
685         RNA_def_property_struct_type(prop, "BoneGroup");
686         RNA_def_property_flag(prop, PROP_EDITABLE);
687         RNA_def_property_pointer_funcs(prop, "rna_PoseChannel_bone_group_get", "rna_PoseChannel_bone_group_set", NULL);
688         RNA_def_property_ui_text(prop, "Bone Group", "Bone Group this pose channel belongs to");
689         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
690         
691         /* transform locks */
692         prop= RNA_def_property(srna, "lock_location", PROP_BOOLEAN, PROP_XYZ);
693         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_LOCX);
694         RNA_def_property_array(prop, 3);
695         RNA_def_property_ui_text(prop, "Lock Location", "Lock editing of location in the interface.");
696         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
697
698         prop= RNA_def_property(srna, "lock_rotation", PROP_BOOLEAN, PROP_XYZ);
699         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTX);
700         RNA_def_property_array(prop, 3);
701         RNA_def_property_ui_text(prop, "Lock Rotation", "Lock editing of rotation in the interface.");
702         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
703         
704                 // XXX this is sub-optimal - it really should be included above, but due to technical reasons we can't do this!
705         prop= RNA_def_property(srna, "lock_rotation_w", PROP_BOOLEAN, PROP_NONE);
706         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTW);
707         RNA_def_property_ui_text(prop, "Lock Rotation (4D Angle)", "Lock editing of 'angle' component of four-component rotations in the interface.");
708         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
709                 // XXX this needs a better name
710         prop= RNA_def_property(srna, "lock_rotations_4d", PROP_BOOLEAN, PROP_NONE);
711         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROT4D);
712         RNA_def_property_ui_text(prop, "Lock Rotations (4D)", "Lock editing of four component rotations by components (instead of as Eulers).");
713         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
714
715         prop= RNA_def_property(srna, "lock_scale", PROP_BOOLEAN, PROP_XYZ);
716         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_SCALEX);
717         RNA_def_property_array(prop, 3);
718         RNA_def_property_ui_text(prop, "Lock Scale", "Lock editing of scale in the interface.");
719         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
720 }
721
722 static void rna_def_pose(BlenderRNA *brna)
723 {
724         StructRNA *srna;
725         PropertyRNA *prop;
726         
727         /* struct definition */
728         srna= RNA_def_struct(brna, "Pose", NULL);
729         RNA_def_struct_sdna(srna, "bPose");
730         RNA_def_struct_ui_text(srna, "Pose", "A collection of pose channels, including settings for animating bones.");
731
732         /* pose channels */
733         prop= RNA_def_property(srna, "pose_channels", PROP_COLLECTION, PROP_NONE);
734         RNA_def_property_collection_sdna(prop, NULL, "chanbase", NULL);
735         RNA_def_property_struct_type(prop, "PoseChannel");
736         RNA_def_property_ui_text(prop, "Pose Channels", "Individual pose channels for the armature.");
737
738         /* bone groups */
739         prop= RNA_def_property(srna, "bone_groups", PROP_COLLECTION, PROP_NONE);
740         RNA_def_property_collection_sdna(prop, NULL, "agroups", NULL);
741         RNA_def_property_struct_type(prop, "BoneGroup");
742         RNA_def_property_ui_text(prop, "Bone Groups", "Groups of the bones.");
743
744         prop= RNA_def_property(srna, "active_bone_group", PROP_POINTER, PROP_NONE);
745         RNA_def_property_struct_type(prop, "BoneGroup");
746         RNA_def_property_flag(prop, PROP_EDITABLE);
747         RNA_def_property_pointer_funcs(prop, "rna_Pose_active_bone_group_get", "rna_Pose_active_bone_group_set", NULL);
748         RNA_def_property_ui_text(prop, "Active Bone Group", "Active bone group for this pose.");
749         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
750
751         prop= RNA_def_property(srna, "active_bone_group_index", PROP_INT, PROP_NONE);
752         RNA_def_property_int_sdna(prop, NULL, "active_group");
753         RNA_def_property_int_funcs(prop, "rna_Pose_active_bone_group_index_get", "rna_Pose_active_bone_group_index_set", "rna_Pose_active_bone_group_index_range");
754         RNA_def_property_ui_text(prop, "Active Bone Group Index", "Active index in bone groups array.");
755         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
756 }
757
758 void RNA_def_pose(BlenderRNA *brna)
759 {
760         rna_def_pose(brna);
761         rna_def_pose_channel(brna);
762         
763         rna_def_bone_group(brna);
764 }
765
766 #endif