2.5 - Rotation Order Tweaks
[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 static void rna_PoseChannel_euler_rotation_get(PointerRNA *ptr, float *value)
114 {
115         bPoseChannel *pchan= ptr->data;
116
117         if(pchan->rotmode == PCHAN_ROT_QUAT)
118                 QuatToEul(pchan->quat, value);
119         else
120                 VECCOPY(value, pchan->eul);
121 }
122
123 static void rna_PoseChannel_euler_rotation_set(PointerRNA *ptr, const float *value)
124 {
125         bPoseChannel *pchan= ptr->data;
126
127         if(pchan->rotmode == PCHAN_ROT_QUAT) /* default XYZ eulers when using quats... */
128                 EulToQuat((float*)value, pchan->quat);
129         else
130                 VECCOPY(pchan->eul, value);
131 }
132
133 static void rna_PoseChannel_rotation_mode_set(PointerRNA *ptr, int value)
134 {
135         bPoseChannel *pchan= ptr->data;
136         
137         /* check if any change - if so, need to convert data */
138         // TODO: this needs to be generalised at some point to work for objects too...
139         if (value > 0) { /* to euler */
140                 if (pchan->rotmode < 0) { // FIXME: need a define for this
141                         /* axis-angle to euler */
142                         float m[3][3];
143                         
144                         /* convert to 3x3 matrix, then to euler 
145                          *      - axis angle is stored in quats
146                          */
147                         VecRotToMat3(&pchan->quat[1], pchan->quat[0], m);
148                         Mat3ToEulO(m, pchan->eul, value);
149                 }
150                 else if (pchan->rotmode == PCHAN_ROT_QUAT) {
151                         /* quat to euler */
152                         QuatToEulO(pchan->quat, pchan->eul, value);
153                 }
154                 /* else { no conversion needed } */
155         }
156         else if (value == PCHAN_ROT_QUAT) { /* to quat */
157                 if (pchan->rotmode < 0) { // FIXME: need a define for this
158                         /* axis angle to quat */
159                         float q[4];
160                         
161                         /* copy to temp var first, since quats and axis-angle are stored in same place */
162                         QuatCopy(q, pchan->quat);
163                         AxisAngleToQuat(q, &pchan->quat[1], pchan->quat[0]);
164                 }
165                 else if (pchan->rotmode > 0) {
166                         /* euler to quat */
167                         EulOToQuat(pchan->eul, pchan->rotmode, pchan->quat);
168                 }
169                 /* else { no conversion needed } */
170         }
171         else { /* to axis-angle */
172                 if (pchan->rotmode > 0) { // FIXME: need a define for this
173                         /* euler to axis angle */
174                         float q[4];
175                         
176                         /* convert to temp quat, then to axis angle (since stored in same var) */
177                         EulOToQuat(pchan->eul, pchan->rotmode, q);
178                         QuatToAxisAngle(q, &pchan->quat[1], pchan->quat[0]);
179                 }
180                 else if (pchan->rotmode == PCHAN_ROT_QUAT) {
181                         /* quat to axis angle */
182                         float q[4];
183                         
184                         /* copy to temp var first, since quats and axis-angle are stored in same place */
185                         QuatCopy(q, pchan->quat);
186                         QuatToAxisAngle(q, &pchan->quat[1], pchan->quat[0]);
187                 }
188         }
189         
190         /* finally, set the new rotation type */
191         pchan->rotmode= value;
192 }
193
194 static void rna_PoseChannel_name_set(PointerRNA *ptr, const char *value)
195 {
196         Object *ob= (Object*)ptr->id.data;
197         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
198         char oldname[32], newname[32];
199         
200         /* need to be on the stack */
201         BLI_strncpy(newname, value, 32);
202         BLI_strncpy(oldname, pchan->name, 32);
203         
204         ED_armature_bone_rename(ob->data, oldname, newname);
205 }
206
207 static int rna_PoseChannel_has_ik_get(PointerRNA *ptr)
208 {
209         Object *ob= (Object*)ptr->id.data;
210         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
211
212         return ED_pose_channel_in_IK_chain(ob, pchan);
213 }
214
215 static PointerRNA rna_PoseChannel_bone_group_get(PointerRNA *ptr)
216 {
217         Object *ob= (Object*)ptr->id.data;
218         bPose *pose= (ob) ? ob->pose : NULL;
219         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
220         bActionGroup *grp;
221         
222         if (pose)
223                 grp= BLI_findlink(&pose->agroups, pchan->agrp_index-1);
224         else
225                 grp= NULL;
226         
227         return rna_pointer_inherit_refine(ptr, &RNA_BoneGroup, grp);
228 }
229
230 static void rna_PoseChannel_bone_group_set(PointerRNA *ptr, PointerRNA value)
231 {
232         Object *ob= (Object*)ptr->id.data;
233         bPose *pose= (ob) ? ob->pose : NULL;
234         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
235         
236         if (pose)
237                 pchan->agrp_index= BLI_findindex(&pose->agroups, value.data) + 1;
238         else
239                 pchan->agrp_index= 0;
240 }
241
242 static int rna_PoseChannel_bone_group_index_get(PointerRNA *ptr)
243 {
244         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
245         return MAX2(pchan->agrp_index-1, 0);
246 }
247
248 static void rna_PoseChannel_bone_group_index_set(PointerRNA *ptr, int value)
249 {
250         bPoseChannel *pchan= (bPoseChannel*)ptr->data;
251         pchan->agrp_index= value+1;
252 }
253
254 static void rna_PoseChannel_bone_group_index_range(PointerRNA *ptr, int *min, int *max)
255 {
256         Object *ob= (Object*)ptr->id.data;
257         bPose *pose= (ob) ? ob->pose : NULL;
258         
259         *min= 0;
260         
261         if (pose) {
262                 *max= BLI_countlist(&pose->agroups)-1;
263                 *max= MAX2(0, *max);
264         }
265         else
266                 *max= 0;
267 }
268
269 static PointerRNA rna_Pose_active_bone_group_get(PointerRNA *ptr)
270 {
271         bPose *pose= (bPose*)ptr->data;
272         return rna_pointer_inherit_refine(ptr, &RNA_BoneGroup, BLI_findlink(&pose->agroups, pose->active_group-1));
273 }
274
275 static void rna_Pose_active_bone_group_set(PointerRNA *ptr, PointerRNA value)
276 {
277         bPose *pose= (bPose*)ptr->data;
278         pose->active_group= BLI_findindex(&pose->agroups, value.data) + 1;
279 }
280
281 static int rna_Pose_active_bone_group_index_get(PointerRNA *ptr)
282 {
283         bPose *pose= (bPose*)ptr->data;
284         return MAX2(pose->active_group-1, 0);
285 }
286
287 static void rna_Pose_active_bone_group_index_set(PointerRNA *ptr, int value)
288 {
289         bPose *pose= (bPose*)ptr->data;
290         pose->active_group= value+1;
291 }
292
293 static void rna_Pose_active_bone_group_index_range(PointerRNA *ptr, int *min, int *max)
294 {
295         bPose *pose= (bPose*)ptr->data;
296
297         *min= 0;
298         *max= BLI_countlist(&pose->agroups)-1;
299         *max= MAX2(0, *max);
300 }
301
302 void rna_pose_bgroup_name_index_get(PointerRNA *ptr, char *value, int index)
303 {
304         bPose *pose= (bPose*)ptr->data;
305         bActionGroup *grp;
306
307         grp= BLI_findlink(&pose->agroups, index-1);
308
309         if(grp) BLI_strncpy(value, grp->name, sizeof(grp->name));
310         else BLI_strncpy(value, "", sizeof(grp->name)); // XXX if invalid pointer, won't this crash?
311 }
312
313 int rna_pose_bgroup_name_index_length(PointerRNA *ptr, int index)
314 {
315         bPose *pose= (bPose*)ptr->data;
316         bActionGroup *grp;
317
318         grp= BLI_findlink(&pose->agroups, index-1);
319         return (grp)? strlen(grp->name): 0;
320 }
321
322 void rna_pose_bgroup_name_index_set(PointerRNA *ptr, const char *value, short *index)
323 {
324         bPose *pose= (bPose*)ptr->data;
325         bActionGroup *grp;
326         int a;
327         
328         for (a=1, grp=pose->agroups.first; grp; grp=grp->next, a++) {
329                 if (strcmp(grp->name, value) == 0) {
330                         *index= a;
331                         return;
332                 }
333         }
334         
335         *index= 0;
336 }
337
338 void rna_pose_pgroup_name_set(PointerRNA *ptr, const char *value, char *result, int maxlen)
339 {
340         bPose *pose= (bPose*)ptr->data;
341         bActionGroup *grp;
342         
343         for (grp= pose->agroups.first; grp; grp= grp->next) {
344                 if (strcmp(grp->name, value) == 0) {
345                         BLI_strncpy(result, value, maxlen);
346                         return;
347                 }
348         }
349         
350         BLI_strncpy(result, "", maxlen);
351 }
352
353 #else
354
355 static void rna_def_bone_group(BlenderRNA *brna)
356 {
357         static EnumPropertyItem prop_colorSets_items[] = {
358                 {0, "DEFAULT", 0, "Default Colors", ""},
359                 {1, "THEME01", 0, "01 - Theme Color Set", ""},
360                 {2, "THEME02", 0, "02 - Theme Color Set", ""},
361                 {3, "THEME03", 0, "03 - Theme Color Set", ""},
362                 {4, "THEME04", 0, "04 - Theme Color Set", ""},
363                 {5, "THEME05", 0, "05 - Theme Color Set", ""},
364                 {6, "THEME06", 0, "06 - Theme Color Set", ""},
365                 {7, "THEME07", 0, "07 - Theme Color Set", ""},
366                 {8, "THEME08", 0, "08 - Theme Color Set", ""},
367                 {9, "THEME09", 0, "09 - Theme Color Set", ""},
368                 {10, "THEME10", 0, "10 - Theme Color Set", ""},
369                 {11, "THEME11", 0, "11 - Theme Color Set", ""},
370                 {12, "THEME12", 0, "12 - Theme Color Set", ""},
371                 {13, "THEME13", 0, "13 - Theme Color Set", ""},
372                 {14, "THEME14", 0, "14 - Theme Color Set", ""},
373                 {15, "THEME15", 0, "15 - Theme Color Set", ""},
374                 {16, "THEME16", 0, "16 - Theme Color Set", ""},
375                 {17, "THEME17", 0, "17 - Theme Color Set", ""},
376                 {18, "THEME18", 0, "18 - Theme Color Set", ""},
377                 {19, "THEME19", 0, "19 - Theme Color Set", ""},
378                 {20, "THEME20", 0, "20 - Theme Color Set", ""},
379                 {-1, "CUSTOM", 0, "Custom Color Set", ""},
380                 {0, NULL, 0, NULL, NULL}};
381         
382         StructRNA *srna;
383         PropertyRNA *prop;
384         
385         /* struct */
386         srna= RNA_def_struct(brna, "BoneGroup", NULL);
387         RNA_def_struct_sdna(srna, "bActionGroup");
388         RNA_def_struct_ui_text(srna, "Bone Group", "Groups of Pose Channels (Bones).");
389         
390         /* name */
391         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
392         RNA_def_property_ui_text(prop, "Name", "");
393         RNA_def_struct_name_property(srna, prop);
394         
395         // TODO: add some runtime-collections stuff to access grouped bones 
396         
397         /* color set + colors */
398         prop= RNA_def_property(srna, "color_set", PROP_ENUM, PROP_NONE);
399         RNA_def_property_enum_sdna(prop, NULL, "customCol");
400         RNA_def_property_enum_items(prop, prop_colorSets_items);
401         RNA_def_property_enum_funcs(prop, NULL, "rna_BoneGroup_color_set_set", NULL);
402         RNA_def_property_ui_text(prop, "Color Set", "Custom color set to use.");
403         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
404         
405                 // TODO: editing the colors for this should result in changes to the color type...
406         prop= RNA_def_property(srna, "colors", PROP_POINTER, PROP_NEVER_NULL);
407         RNA_def_property_struct_type(prop, "ThemeBoneColorSet");
408         RNA_def_property_pointer_sdna(prop, NULL, "cs"); /* NOTE: the DNA data is not really a pointer, but this code works :) */
409         RNA_def_property_ui_text(prop, "Colors", "Copy of the colors associated with the group's color set.");
410         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
411 }
412
413 static void rna_def_pose_channel(BlenderRNA *brna)
414 {
415         static EnumPropertyItem prop_rotmode_items[] = {
416                 {PCHAN_ROT_QUAT, "QUATERNION", 0, "Quaternion (WXYZ)", "No Gimbal Lock (default)"},
417                 {PCHAN_ROT_XYZ, "XYZ", 0, "XYZ Euler", "XYZ Rotation Order. Prone to Gimbal Lock"},
418                 {PCHAN_ROT_XZY, "XZY", 0, "XZY Euler", "XZY Rotation Order. Prone to Gimbal Lock"},
419                 {PCHAN_ROT_YXZ, "YXZ", 0, "YXZ Euler", "YXZ Rotation Order. Prone to Gimbal Lock"},
420                 {PCHAN_ROT_YZX, "YZX", 0, "YZX Euler", "YZX Rotation Order. Prone to Gimbal Lock"},
421                 {PCHAN_ROT_ZXY, "ZXY", 0, "ZXY Euler", "ZXY Rotation Order. Prone to Gimbal Lock"},
422                 {PCHAN_ROT_ZYX, "ZYX", 0, "ZYX Euler", "ZYX Rotation Order. Prone to Gimbal Lock"},
423                 {0, NULL, 0, NULL, NULL}};
424         
425         StructRNA *srna;
426         PropertyRNA *prop;
427
428         srna= RNA_def_struct(brna, "PoseChannel", NULL);
429         RNA_def_struct_sdna(srna, "bPoseChannel");
430         RNA_def_struct_ui_text(srna, "Pose Channel", "Channel defining pose data for a bone in a Pose.");
431         RNA_def_struct_path_func(srna, "rna_PoseChannel_path");
432         RNA_def_struct_idproperties_func(srna, "rna_PoseChannel_idproperties");
433         
434         /* Bone Constraints */
435         prop= RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
436         RNA_def_property_struct_type(prop, "Constraint");
437         RNA_def_property_ui_text(prop, "Constraints", "Constraints that act on this PoseChannel."); 
438
439         /* Name + Selection Status */
440         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
441         RNA_def_property_string_funcs(prop, NULL, NULL, "rna_PoseChannel_name_set");
442         RNA_def_property_ui_text(prop, "Name", "");
443         RNA_def_struct_name_property(srna, prop);
444         
445         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
446         RNA_def_property_boolean_sdna(prop, NULL, "selectflag", BONE_SELECTED);
447         RNA_def_property_ui_text(prop, "Selected", "");
448
449         /* Baked Bone Path cache data s*/
450         prop= RNA_def_property(srna, "path_start_frame", PROP_INT, PROP_TIME);
451         RNA_def_property_int_sdna(prop, NULL, "pathsf");
452         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
453         RNA_def_property_ui_text(prop, "Bone Paths Calculation Start Frame", "Starting frame of range of frames to use for Bone Path calculations.");
454         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
455
456         prop= RNA_def_property(srna, "path_end_frame", PROP_INT, PROP_TIME);
457         RNA_def_property_int_sdna(prop, NULL, "pathef");
458         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
459         RNA_def_property_ui_text(prop, "Bone Paths Calculation End Frame", "End frame of range of frames to use for Bone Path calculations.");
460         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
461         
462         /* Relationships to other bones */
463         prop= RNA_def_property(srna, "bone", PROP_POINTER, PROP_NEVER_NULL);
464         RNA_def_property_struct_type(prop, "Bone");
465         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
466         RNA_def_property_ui_text(prop, "Bone", "Bone associated with this Pose Channel.");
467
468         prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
469         RNA_def_property_struct_type(prop, "PoseChannel");
470         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
471         RNA_def_property_ui_text(prop, "Parent", "Parent of this pose channel.");
472
473         prop= RNA_def_property(srna, "child", PROP_POINTER, PROP_NONE);
474         RNA_def_property_struct_type(prop, "PoseChannel");
475         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
476         RNA_def_property_ui_text(prop, "Child", "Child of this pose channel.");
477         
478         /* Transformation settings */
479         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_TRANSLATION);
480         RNA_def_property_float_sdna(prop, NULL, "loc");
481         RNA_def_property_ui_text(prop, "Location", "");
482         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
483
484         prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_XYZ);
485         RNA_def_property_float_sdna(prop, NULL, "size");
486         RNA_def_property_ui_text(prop, "Scale", "");
487         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
488
489         prop= RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_QUATERNION);
490         RNA_def_property_float_sdna(prop, NULL, "quat");
491         RNA_def_property_ui_text(prop, "Rotation", "Rotation in Quaternions.");
492         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
493         
494         prop= RNA_def_property(srna, "euler_rotation", PROP_FLOAT, PROP_EULER);
495         RNA_def_property_float_sdna(prop, NULL, "eul");
496         RNA_def_property_float_funcs(prop, "rna_PoseChannel_euler_rotation_get", "rna_PoseChannel_euler_rotation_set", NULL);
497         RNA_def_property_ui_text(prop, "Rotation (Euler)", "Rotation in Eulers.");
498         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
499         
500         prop= RNA_def_property(srna, "rotation_mode", PROP_ENUM, PROP_NONE);
501         RNA_def_property_enum_sdna(prop, NULL, "rotmode");
502         RNA_def_property_enum_items(prop, prop_rotmode_items);
503         RNA_def_property_enum_funcs(prop, NULL, "rna_PoseChannel_rotation_mode_set", NULL);
504         RNA_def_property_ui_text(prop, "Rotation Mode", "");
505         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
506
507         /* These three matrix properties await an implementation of the PROP_MATRIX subtype, which currently doesn't exist. */
508 /*      prop= RNA_def_property(srna, "channel_matrix", PROP_FLOAT, PROP_MATRIX);
509         RNA_def_property_struct_type(prop, "chan_mat");
510         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
511         RNA_def_property_ui_text(prop, "Channel Matrix", "4x4 matrix, before constraints.");*/
512
513         /* kaito says this should be not user-editable; I disagree; power users should be able to force this in python; he's the boss. */
514 /*      prop= RNA_def_property(srna, "pose_matrix", PROP_FLOAT, PROP_MATRIX);
515         RNA_def_property_struct_type(prop, "pose_mat");
516         RNA_def_property_clear_flag(prop, PROP_EDITABLE); 
517         RNA_def_property_ui_text(prop, "Pose Matrix", "Final 4x4 matrix for this channel.");
518
519         prop= RNA_def_property(srna, "constraint_inverse_matrix", PROP_FLOAT, PROP_MATRIX);
520         RNA_def_property_struct_type(prop, "constinv");
521         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
522         RNA_def_property_ui_text(prop, "Constraint Inverse Matrix", "4x4 matrix, defines transform from final position to unconstrained position."); */
523         
524         /* Head/Tail Coordinates (in Pose Space) - Automatically calculated... */
525         prop= RNA_def_property(srna, "pose_head", PROP_FLOAT, PROP_TRANSLATION);
526         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
527         RNA_def_property_ui_text(prop, "Pose Head Position", "Location of head of the channel's bone.");
528
529         prop= RNA_def_property(srna, "pose_tail", PROP_FLOAT, PROP_TRANSLATION);
530         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
531         RNA_def_property_ui_text(prop, "Pose Tail Position", "Location of tail of the channel's bone.");
532         
533         /* IK Settings */
534         prop= RNA_def_property(srna, "has_ik", PROP_BOOLEAN, PROP_NONE);
535         RNA_def_property_boolean_funcs(prop,  "rna_PoseChannel_has_ik_get", NULL);
536         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
537         RNA_def_property_ui_text(prop, "Has IK", "Is part of an IK chain.");
538         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
539
540         prop= RNA_def_property(srna, "ik_dof_x", PROP_BOOLEAN, PROP_NONE);
541         RNA_def_property_boolean_negative_sdna(prop, NULL, "ikflag", BONE_IK_NO_XDOF);
542         RNA_def_property_ui_text(prop, "IK X DoF", "Allow movement around the X axis.");
543         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
544
545         prop= RNA_def_property(srna, "ik_dof_y", PROP_BOOLEAN, PROP_NONE);
546         RNA_def_property_boolean_negative_sdna(prop, NULL, "ikflag", BONE_IK_NO_YDOF);
547         RNA_def_property_ui_text(prop, "IK Y DoF", "Allow movement around the Y axis.");
548         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
549
550         prop= RNA_def_property(srna, "ik_dof_z", PROP_BOOLEAN, PROP_NONE);
551         RNA_def_property_boolean_negative_sdna(prop, NULL, "ikflag", BONE_IK_NO_ZDOF);
552         RNA_def_property_ui_text(prop, "IK Z DoF", "Allow movement around the Z axis.");
553         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
554
555         prop= RNA_def_property(srna, "ik_limit_x", PROP_BOOLEAN, PROP_NONE);
556         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_XLIMIT);
557         RNA_def_property_ui_text(prop, "IK X Limit", "Limit movement around the X axis.");
558         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
559
560         prop= RNA_def_property(srna, "ik_limit_y", PROP_BOOLEAN, PROP_NONE);
561         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_YLIMIT);
562         RNA_def_property_ui_text(prop, "IK Y Limit", "Limit movement around the Y axis.");
563         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
564
565         prop= RNA_def_property(srna, "ik_limit_z", PROP_BOOLEAN, PROP_NONE);
566         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ZLIMIT);
567         RNA_def_property_ui_text(prop, "IK Z Limit", "Limit movement around the Z axis.");
568         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
569         
570         prop= RNA_def_property(srna, "ik_min_x", PROP_FLOAT, PROP_ANGLE);
571         RNA_def_property_float_sdna(prop, NULL, "limitmin[0]");
572         RNA_def_property_range(prop, -180.0f, 0.0f);
573         RNA_def_property_ui_text(prop, "IK X Minimum", "Minimum angles for IK Limit");
574         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
575
576         prop= RNA_def_property(srna, "ik_max_x", PROP_FLOAT, PROP_ANGLE);
577         RNA_def_property_float_sdna(prop, NULL, "limitmax[0]");
578         RNA_def_property_range(prop, 0.0f, 180.0f);
579         RNA_def_property_ui_text(prop, "IK X Maximum", "Maximum angles for IK Limit");
580         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
581
582         prop= RNA_def_property(srna, "ik_min_y", PROP_FLOAT, PROP_ANGLE);
583         RNA_def_property_float_sdna(prop, NULL, "limitmin[1]");
584         RNA_def_property_range(prop, -180.0f, 0.0f);
585         RNA_def_property_ui_text(prop, "IK Y Minimum", "Minimum angles for IK Limit");
586         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
587
588         prop= RNA_def_property(srna, "ik_max_y", PROP_FLOAT, PROP_ANGLE);
589         RNA_def_property_float_sdna(prop, NULL, "limitmax[1]");
590         RNA_def_property_range(prop, 0.0f, 180.0f);
591         RNA_def_property_ui_text(prop, "IK Y Maximum", "Maximum angles for IK Limit");
592         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
593
594         prop= RNA_def_property(srna, "ik_min_z", PROP_FLOAT, PROP_ANGLE);
595         RNA_def_property_float_sdna(prop, NULL, "limitmin[2]");
596         RNA_def_property_range(prop, -180.0f, 0.0f);
597         RNA_def_property_ui_text(prop, "IK Z Minimum", "Minimum angles for IK Limit");
598         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
599
600         prop= RNA_def_property(srna, "ik_max_z", PROP_FLOAT, PROP_ANGLE);
601         RNA_def_property_float_sdna(prop, NULL, "limitmax[2]");
602         RNA_def_property_range(prop, 0.0f, 180.0f);
603         RNA_def_property_ui_text(prop, "IK Z Maximum", "Maximum angles for IK Limit");
604         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
605
606         prop= RNA_def_property(srna, "ik_stiffness_x", PROP_FLOAT, PROP_NONE);
607         RNA_def_property_float_sdna(prop, NULL, "stiffness[0]");
608         RNA_def_property_range(prop, 0.0f, 0.99f);
609         RNA_def_property_ui_text(prop, "IK X Stiffness", "IK stiffness around the X axis.");
610         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
611
612         prop= RNA_def_property(srna, "ik_stiffness_y", PROP_FLOAT, PROP_NONE);
613         RNA_def_property_float_sdna(prop, NULL, "stiffness[1]");
614         RNA_def_property_range(prop, 0.0f, 0.99f);
615         RNA_def_property_ui_text(prop, "IK Y Stiffness", "IK stiffness around the Y axis.");
616         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
617
618         prop= RNA_def_property(srna, "ik_stiffness_z", PROP_FLOAT, PROP_NONE);
619         RNA_def_property_float_sdna(prop, NULL, "stiffness[2]");
620         RNA_def_property_range(prop, 0.0f, 0.99f);
621         RNA_def_property_ui_text(prop, "IK Z Stiffness", "IK stiffness around the Z axis.");
622         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
623
624         prop= RNA_def_property(srna, "ik_stretch", PROP_FLOAT, PROP_NONE);
625         RNA_def_property_float_sdna(prop, NULL, "ikstretch");
626         RNA_def_property_range(prop, 0.0f,1.0f);
627         RNA_def_property_ui_text(prop, "IK Stretch", "Allow scaling of the bone for IK.");
628         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
629         
630         /* custom bone shapes */
631         prop= RNA_def_property(srna, "custom_shape", PROP_POINTER, PROP_NONE);
632         RNA_def_property_pointer_sdna(prop, NULL, "custom");
633         RNA_def_property_struct_type(prop, "Object");
634         RNA_def_property_flag(prop, PROP_EDITABLE);
635         RNA_def_property_ui_text(prop, "Custom Object", "Object that defines custom draw type for this bone.");
636         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
637         
638         /* bone groups */
639         prop= RNA_def_property(srna, "bone_group_index", PROP_INT, PROP_NONE);
640         RNA_def_property_int_sdna(prop, NULL, "agrp_index");
641         RNA_def_property_flag(prop, PROP_EDITABLE);
642         RNA_def_property_int_funcs(prop, "rna_PoseChannel_bone_group_index_get", "rna_PoseChannel_bone_group_index_set", "rna_PoseChannel_bone_group_index_range");
643         RNA_def_property_ui_text(prop, "Bone Group Index", "Bone Group this pose channel belongs to (0=no group).");
644         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
645         
646         prop= RNA_def_property(srna, "bone_group", PROP_POINTER, PROP_NONE);
647         RNA_def_property_struct_type(prop, "BoneGroup");
648         RNA_def_property_flag(prop, PROP_EDITABLE);
649         RNA_def_property_pointer_funcs(prop, "rna_PoseChannel_bone_group_get", "rna_PoseChannel_bone_group_set", NULL);
650         RNA_def_property_ui_text(prop, "Bone Group", "Bone Group this pose channel belongs to");
651         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
652         
653         /* transform locks */
654         prop= RNA_def_property(srna, "lock_location", PROP_BOOLEAN, PROP_XYZ);
655         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_LOCX);
656         RNA_def_property_array(prop, 3);
657         RNA_def_property_ui_text(prop, "Lock Location", "Lock editing of location in the interface.");
658
659         prop= RNA_def_property(srna, "lock_rotation", PROP_BOOLEAN, PROP_XYZ);
660         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTX);
661         RNA_def_property_array(prop, 3);
662         RNA_def_property_ui_text(prop, "Lock Rotation", "Lock editing of rotation in the interface.");
663
664         prop= RNA_def_property(srna, "lock_scale", PROP_BOOLEAN, PROP_XYZ);
665         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_SCALEX);
666         RNA_def_property_array(prop, 3);
667         RNA_def_property_ui_text(prop, "Lock Scale", "Lock editing of scale in the interface.");
668 }
669
670 static void rna_def_pose(BlenderRNA *brna)
671 {
672         StructRNA *srna;
673         PropertyRNA *prop;
674         
675         /* struct definition */
676         srna= RNA_def_struct(brna, "Pose", NULL);
677         RNA_def_struct_sdna(srna, "bPose");
678         RNA_def_struct_ui_text(srna, "Pose", "A collection of pose channels, including settings for animating bones.");
679
680         /* pose channels */
681         prop= RNA_def_property(srna, "pose_channels", PROP_COLLECTION, PROP_NONE);
682         RNA_def_property_collection_sdna(prop, NULL, "chanbase", NULL);
683         RNA_def_property_struct_type(prop, "PoseChannel");
684         RNA_def_property_ui_text(prop, "Pose Channels", "Individual pose channels for the armature.");
685
686         /* bone groups */
687         prop= RNA_def_property(srna, "bone_groups", PROP_COLLECTION, PROP_NONE);
688         RNA_def_property_collection_sdna(prop, NULL, "agroups", NULL);
689         RNA_def_property_struct_type(prop, "BoneGroup");
690         RNA_def_property_ui_text(prop, "Bone Groups", "Groups of the bones.");
691
692         prop= RNA_def_property(srna, "active_bone_group", PROP_POINTER, PROP_NONE);
693         RNA_def_property_struct_type(prop, "BoneGroup");
694         RNA_def_property_flag(prop, PROP_EDITABLE);
695         RNA_def_property_pointer_funcs(prop, "rna_Pose_active_bone_group_get", "rna_Pose_active_bone_group_set", NULL);
696         RNA_def_property_ui_text(prop, "Active Bone Group", "Active bone group for this pose.");
697         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
698
699         prop= RNA_def_property(srna, "active_bone_group_index", PROP_INT, PROP_NONE);
700         RNA_def_property_int_sdna(prop, NULL, "active_group");
701         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");
702         RNA_def_property_ui_text(prop, "Active Bone Group Index", "Active index in bone groups array.");
703         RNA_def_property_update(prop, NC_OBJECT|ND_POSE, "rna_Pose_update");
704 }
705
706 void RNA_def_pose(BlenderRNA *brna)
707 {
708         rna_def_pose(brna);
709         rna_def_pose_channel(brna);
710         
711         rna_def_bone_group(brna);
712 }
713
714 #endif