a5c8f698085a5db66499db022ea857f8a175e86e
[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
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_scene_types.h"
36
37 #ifdef RNA_RUNTIME
38
39 #else
40
41 /* users shouldn't be editing pose channel data directly -- better to set ipos and let blender calc pose_channel stuff */
42 /* it's going to be weird for users to find IK flags and other such here, instead of in bone where they would expect them
43         -- is there any way to put a doc in bone, pointing them here? */
44
45 static void rna_def_pose_channel(BlenderRNA *brna)
46 {
47         StructRNA *srna;
48         PropertyRNA *prop;
49
50         srna= RNA_def_struct(brna, "PoseChannel", NULL);
51         RNA_def_struct_sdna(srna, "bPoseChannel");
52         RNA_def_struct_ui_text(srna, "Pose Channel", "Member of the 'Pose' type.");
53
54         prop= RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
55         RNA_def_property_collection_sdna(prop, NULL, "constraints", NULL);
56         RNA_def_property_struct_type(prop, "Constraint");
57         RNA_def_property_ui_text(prop, "Constraints", "Constraints that act on this PoseChannel."); 
58
59         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
60         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
61         RNA_def_property_ui_text(prop, "Name", "");
62         RNA_def_struct_name_property(srna, prop);
63
64         prop= RNA_def_property(srna, "ik_dof_x", PROP_BOOLEAN, PROP_NONE);
65         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_XDOF);
66         RNA_def_property_ui_text(prop, "IK X DoF", "Allow movement around the X axis.");
67
68         prop= RNA_def_property(srna, "ik_dof_y", PROP_BOOLEAN, PROP_NONE);
69         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_YDOF);
70         RNA_def_property_ui_text(prop, "IK Y DoF", "Allow movement around the Y axis.");
71
72         prop= RNA_def_property(srna, "ik_dof_z", PROP_BOOLEAN, PROP_NONE);
73         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_ZDOF);
74         RNA_def_property_ui_text(prop, "IK Z DoF", "Allow movement around the Z axis.");
75
76         prop= RNA_def_property(srna, "ik_limit_x", PROP_BOOLEAN, PROP_NONE);
77         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_XLIMIT);
78         RNA_def_property_ui_text(prop, "IK X Limit", "Limit movement around the X axis.");
79
80         prop= RNA_def_property(srna, "ik_limit_y", PROP_BOOLEAN, PROP_NONE);
81         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_YLIMIT);
82         RNA_def_property_ui_text(prop, "IK Y Limit", "Limit movement around the Y axis.");
83
84         prop= RNA_def_property(srna, "ik_limit_z", PROP_BOOLEAN, PROP_NONE);
85         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ZLIMIT);
86         RNA_def_property_ui_text(prop, "IK Z Limit", "Limit movement around the Z axis.");
87         
88         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
89         RNA_def_property_boolean_sdna(prop, NULL, "selectflag", BONE_SELECTED);
90         RNA_def_property_ui_text(prop, "Selected", "");
91         
92         prop= RNA_def_property(srna, "protected", PROP_BOOLEAN, PROP_NONE);
93         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", POSE_LOCKED);
94         RNA_def_property_ui_text(prop, "Protected", "Protect channel from being transformed.");
95
96                 // XXX note: bone groups are stored internally as bActionGroups :) - Aligorith
97         //prop= RNA_def_property(srna, "bone_group_index", PROP_INT, PROP_NONE);
98         //RNA_def_property_int_sdna(prop, NULL, "agrp_index");
99         //RNA_def_property_ui_text(prop, "Bone Group Index", "Bone Group this pose channel belongs to (0=no group).");
100
101         prop= RNA_def_property(srna, "path_start_frame", PROP_INT, PROP_NONE);
102         RNA_def_property_int_sdna(prop, NULL, "pathsf");
103         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
104         RNA_def_property_ui_text(prop, "Bone Paths Calculation Start Frame", "Starting frame of range of frames to use for Bone Path calculations.");
105
106         prop= RNA_def_property(srna, "path_end_frame", PROP_INT, PROP_NONE);
107         RNA_def_property_int_sdna(prop, NULL, "pathef");
108         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
109         RNA_def_property_ui_text(prop, "Bone Paths Calculation End Frame", "End frame of range of frames to use for Bone Path calculations.");
110
111         prop= RNA_def_property(srna, "bone", PROP_POINTER, PROP_NONE);
112         RNA_def_property_struct_type(prop, "Bone");
113         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
114         RNA_def_property_ui_text(prop, "Bone", "Bone associated with this Pose Channel.");
115
116         prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
117         RNA_def_property_struct_type(prop, "PoseChannel");
118         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
119         RNA_def_property_ui_text(prop, "Parent", "Parent of this pose channel.");
120
121         prop= RNA_def_property(srna, "child", PROP_POINTER, PROP_NONE);
122         RNA_def_property_struct_type(prop, "PoseChannel");
123         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
124         RNA_def_property_ui_text(prop, "Parent", "Child of this pose channel.");
125
126         /* These three matrix properties await an implementation of the PROP_MATRIX subtype, which currently doesn't exist. */
127 /*      prop= RNA_def_property(srna, "channel_matrix", PROP_FLOAT, PROP_MATRIX);
128         RNA_def_property_struct_type(prop, "chan_mat");
129         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
130         RNA_def_property_ui_text(prop, "Channel Matrix", "4x4 matrix, before constraints.");*/
131
132         /* kaito says this should be not user-editable; I disagree; power users should be able to force this in python; he's the boss. */
133 /*      prop= RNA_def_property(srna, "pose_matrix", PROP_FLOAT, PROP_MATRIX);
134         RNA_def_property_struct_type(prop, "pose_mat");
135         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); 
136         RNA_def_property_ui_text(prop, "Pose Matrix", "Final 4x4 matrix for this channel.");
137
138         prop= RNA_def_property(srna, "constraint_inverse_matrix", PROP_FLOAT, PROP_MATRIX);
139         RNA_def_property_struct_type(prop, "constinv");
140         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
141         RNA_def_property_ui_text(prop, "Constraint Inverse Matrix", "4x4 matrix, defines transform from final position to unconstrained position."); */
142         
143         prop= RNA_def_property(srna, "pose_head", PROP_FLOAT, PROP_VECTOR);
144         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
145         RNA_def_property_ui_text(prop, "Pose Head Position", "Location of head of the channel's bone.");
146
147         prop= RNA_def_property(srna, "pose_tail", PROP_FLOAT, PROP_VECTOR);
148         RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
149         RNA_def_property_ui_text(prop, "Pose Tail Position", "Location of tail of the channel's bone.");
150
151         prop= RNA_def_property(srna, "ik_minimums", PROP_FLOAT, PROP_VECTOR);
152         RNA_def_property_float_sdna(prop, NULL, "limitmin");
153         RNA_def_property_range(prop, -180.0f, 0.0f);
154         RNA_def_property_ui_text(prop, "IK Minimum Limits", "Minimum angles for IK Limit");
155
156         prop= RNA_def_property(srna, "ik_maximum", PROP_FLOAT, PROP_VECTOR);
157         RNA_def_property_float_sdna(prop, NULL, "limitmax");
158         RNA_def_property_range(prop, 0.0f, 180.0f);
159         RNA_def_property_ui_text(prop, "IK Maximum Limits", "Maximum angles for IK Limit");
160
161         prop= RNA_def_property(srna, "ik_stiffness", PROP_FLOAT, PROP_VECTOR);
162         RNA_def_property_float_sdna(prop, NULL, "stiffness");
163         RNA_def_property_range(prop, 0.0f,0.99f);
164         RNA_def_property_ui_text(prop, "IK Stiffness", "Stiffness around the different axes.");
165
166         prop= RNA_def_property(srna, "ik_stretch", PROP_FLOAT, PROP_NONE);
167         RNA_def_property_float_sdna(prop, NULL, "ikstretch");
168         RNA_def_property_range(prop, 0.0f,1.0f);
169         RNA_def_property_ui_text(prop, "IK Stretch", "Allow scaling of the bone for IK.");
170
171         prop= RNA_def_property(srna, "custom", PROP_POINTER, PROP_NONE);
172         RNA_def_property_ui_text(prop, "Custom Object", "Object that defines custom draw type for this bone.");
173
174 }
175
176 void RNA_def_pose(BlenderRNA *brna)
177 {
178         StructRNA *srna;
179         PropertyRNA *prop;
180
181         rna_def_pose_channel(brna);
182
183         srna= RNA_def_struct(brna, "Pose", NULL);
184         RNA_def_struct_sdna(srna, "bPose");
185         RNA_def_struct_ui_text(srna, "Pose", "A collection of pose channels, including settings for animating bones.");
186
187         prop= RNA_def_property(srna, "pose_channels", PROP_COLLECTION, PROP_NONE);
188         RNA_def_property_collection_sdna(prop, NULL, "chanbase", NULL);
189         RNA_def_property_struct_type(prop, "PoseChannel");
190         RNA_def_property_ui_text(prop, "Pose Channels", "Individual pose channels for the armature.");
191
192         /* commented for now... missing info... */
193         /*prop= RNA_def_property(srna, "action_groups", PROP_COLLECTION, PROP_NONE);
194         RNA_def_property_collection_sdna(prop, NULL, "agroups", NULL);
195         RNA_def_property_struct_type(prop, "ActionGroup");
196         RNA_def_property_ui_text(prop, "Action Groups", "Groups of bones.");*/
197 }
198
199 #endif