RNA:
[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_object_types.h"
36 #include "DNA_scene_types.h"
37
38 #include "WM_types.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "BKE_context.h"
43 #include "BKE_depsgraph.h"
44 #include "BKE_idprop.h"
45
46 static void rna_Pose_update(bContext *C, PointerRNA *ptr)
47 {
48         DAG_object_flush_update(CTX_data_scene(C), ptr->id.data, OB_RECALC_DATA);
49 }
50
51 IDProperty *rna_PoseChannel_idproperties(PointerRNA *ptr, int create)
52 {
53         bPoseChannel *pchan= ptr->data;
54
55         if(create && !pchan->prop) {
56                 IDPropertyTemplate val = {0};
57                 pchan->prop= IDP_New(IDP_GROUP, val, "RNA_PoseChannel group");
58         }
59
60         return pchan->prop;
61 }
62
63 #else
64
65 /* users shouldn't be editing pose channel data directly -- better to set ipos and let blender calc pose_channel stuff */
66 /* 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
67         -- is there any way to put a doc in bone, pointing them here? */
68
69 static void rna_def_pose_channel(BlenderRNA *brna)
70 {
71         static EnumPropertyItem prop_rotmode_items[] = {
72                 {PCHAN_ROT_QUAT, "QUATERNION", "Quaternion (WXYZ)", "No Gimbal Lock (default)"},
73                 {PCHAN_ROT_EUL, "EULER", "Euler (XYZ)", "Prone to Gimbal Lock"},
74                 {0, NULL, NULL, NULL}};
75         
76         StructRNA *srna;
77         PropertyRNA *prop;
78
79         srna= RNA_def_struct(brna, "PoseChannel", NULL);
80         RNA_def_struct_sdna(srna, "bPoseChannel");
81         RNA_def_struct_ui_text(srna, "Pose Channel", "Channel defining pose data for a bone in a Pose.");
82         RNA_def_struct_idproperties_func(srna, "rna_PoseChannel_idproperties");
83
84         prop= RNA_def_property(srna, "constraints", PROP_COLLECTION, PROP_NONE);
85         RNA_def_property_collection_sdna(prop, NULL, "constraints", NULL);
86         RNA_def_property_struct_type(prop, "Constraint");
87         RNA_def_property_ui_text(prop, "Constraints", "Constraints that act on this PoseChannel."); 
88
89         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
90         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
91         RNA_def_property_ui_text(prop, "Name", "");
92         RNA_def_struct_name_property(srna, prop);
93
94         prop= RNA_def_property(srna, "ik_dof_x", PROP_BOOLEAN, PROP_NONE);
95         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_XDOF);
96         RNA_def_property_ui_text(prop, "IK X DoF", "Allow movement around the X axis.");
97
98         prop= RNA_def_property(srna, "ik_dof_y", PROP_BOOLEAN, PROP_NONE);
99         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_YDOF);
100         RNA_def_property_ui_text(prop, "IK Y DoF", "Allow movement around the Y axis.");
101
102         prop= RNA_def_property(srna, "ik_dof_z", PROP_BOOLEAN, PROP_NONE);
103         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_NO_ZDOF);
104         RNA_def_property_ui_text(prop, "IK Z DoF", "Allow movement around the Z axis.");
105
106         prop= RNA_def_property(srna, "ik_limit_x", PROP_BOOLEAN, PROP_NONE);
107         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_XLIMIT);
108         RNA_def_property_ui_text(prop, "IK X Limit", "Limit movement around the X axis.");
109
110         prop= RNA_def_property(srna, "ik_limit_y", PROP_BOOLEAN, PROP_NONE);
111         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_YLIMIT);
112         RNA_def_property_ui_text(prop, "IK Y Limit", "Limit movement around the Y axis.");
113
114         prop= RNA_def_property(srna, "ik_limit_z", PROP_BOOLEAN, PROP_NONE);
115         RNA_def_property_boolean_sdna(prop, NULL, "ikflag", BONE_IK_ZLIMIT);
116         RNA_def_property_ui_text(prop, "IK Z Limit", "Limit movement around the Z axis.");
117         
118         prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
119         RNA_def_property_boolean_sdna(prop, NULL, "selectflag", BONE_SELECTED);
120         RNA_def_property_ui_text(prop, "Selected", "");
121         
122                 /* XXX note: bone groups are stored internally as bActionGroups :) - Aligorith */
123         prop= RNA_def_property(srna, "bone_group_index", PROP_INT, PROP_NONE);
124         RNA_def_property_int_sdna(prop, NULL, "agrp_index");
125         RNA_def_property_ui_text(prop, "Bone Group Index", "Bone Group this pose channel belongs to (0=no group).");
126
127         prop= RNA_def_property(srna, "path_start_frame", PROP_INT, PROP_NONE);
128         RNA_def_property_int_sdna(prop, NULL, "pathsf");
129         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
130         RNA_def_property_ui_text(prop, "Bone Paths Calculation Start Frame", "Starting frame of range of frames to use for Bone Path calculations.");
131
132         prop= RNA_def_property(srna, "path_end_frame", PROP_INT, PROP_NONE);
133         RNA_def_property_int_sdna(prop, NULL, "pathef");
134         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
135         RNA_def_property_ui_text(prop, "Bone Paths Calculation End Frame", "End frame of range of frames to use for Bone Path calculations.");
136
137         prop= RNA_def_property(srna, "bone", PROP_POINTER, PROP_NEVER_NULL);
138         RNA_def_property_struct_type(prop, "Bone");
139         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
140         RNA_def_property_ui_text(prop, "Bone", "Bone associated with this Pose Channel.");
141
142         prop= RNA_def_property(srna, "parent", PROP_POINTER, PROP_NONE);
143         RNA_def_property_struct_type(prop, "PoseChannel");
144         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
145         RNA_def_property_ui_text(prop, "Parent", "Parent of this pose channel.");
146
147         prop= RNA_def_property(srna, "child", PROP_POINTER, PROP_NONE);
148         RNA_def_property_struct_type(prop, "PoseChannel");
149         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
150         RNA_def_property_ui_text(prop, "Child", "Child of this pose channel.");
151
152         prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_VECTOR);
153         RNA_def_property_float_sdna(prop, NULL, "loc");
154         RNA_def_property_ui_text(prop, "Location", "");
155         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
156
157         prop= RNA_def_property(srna, "scale", PROP_FLOAT, PROP_VECTOR);
158         RNA_def_property_float_sdna(prop, NULL, "size");
159         RNA_def_property_ui_text(prop, "Scale", "");
160         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
161
162         prop= RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ROTATION);
163         RNA_def_property_float_sdna(prop, NULL, "quat");
164         RNA_def_property_ui_text(prop, "Rotation", "Rotation in Quaternions.");
165         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
166         
167         prop= RNA_def_property(srna, "euler_rotation", PROP_FLOAT, PROP_ROTATION);
168         RNA_def_property_float_sdna(prop, NULL, "eul");
169         RNA_def_property_ui_text(prop, "Rotation (Euler)", "Rotation in Eulers.");
170         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
171         
172         prop= RNA_def_property(srna, "rotation_mode", PROP_ENUM, PROP_NONE);
173         RNA_def_property_enum_sdna(prop, NULL, "rotmode");
174         RNA_def_property_enum_items(prop, prop_rotmode_items);
175         RNA_def_property_ui_text(prop, "Rotation Mode", "");
176         RNA_def_property_update(prop, NC_OBJECT|ND_POSE|ND_TRANSFORM, "rna_Pose_update");
177
178         /* These three matrix properties await an implementation of the PROP_MATRIX subtype, which currently doesn't exist. */
179 /*      prop= RNA_def_property(srna, "channel_matrix", PROP_FLOAT, PROP_MATRIX);
180         RNA_def_property_struct_type(prop, "chan_mat");
181         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
182         RNA_def_property_ui_text(prop, "Channel Matrix", "4x4 matrix, before constraints.");*/
183
184         /* kaito says this should be not user-editable; I disagree; power users should be able to force this in python; he's the boss. */
185 /*      prop= RNA_def_property(srna, "pose_matrix", PROP_FLOAT, PROP_MATRIX);
186         RNA_def_property_struct_type(prop, "pose_mat");
187         RNA_def_property_clear_flag(prop, PROP_EDITABLE); 
188         RNA_def_property_ui_text(prop, "Pose Matrix", "Final 4x4 matrix for this channel.");
189
190         prop= RNA_def_property(srna, "constraint_inverse_matrix", PROP_FLOAT, PROP_MATRIX);
191         RNA_def_property_struct_type(prop, "constinv");
192         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
193         RNA_def_property_ui_text(prop, "Constraint Inverse Matrix", "4x4 matrix, defines transform from final position to unconstrained position."); */
194         
195         prop= RNA_def_property(srna, "pose_head", PROP_FLOAT, PROP_VECTOR);
196         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
197         RNA_def_property_ui_text(prop, "Pose Head Position", "Location of head of the channel's bone.");
198
199         prop= RNA_def_property(srna, "pose_tail", PROP_FLOAT, PROP_VECTOR);
200         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
201         RNA_def_property_ui_text(prop, "Pose Tail Position", "Location of tail of the channel's bone.");
202
203         prop= RNA_def_property(srna, "ik_min_limits", PROP_FLOAT, PROP_VECTOR);
204         RNA_def_property_float_sdna(prop, NULL, "limitmin");
205         RNA_def_property_range(prop, -180.0f, 0.0f);
206         RNA_def_property_ui_text(prop, "IK Minimum Limits", "Minimum angles for IK Limit");
207
208         prop= RNA_def_property(srna, "ik_max_limits", PROP_FLOAT, PROP_VECTOR);
209         RNA_def_property_float_sdna(prop, NULL, "limitmax");
210         RNA_def_property_range(prop, 0.0f, 180.0f);
211         RNA_def_property_ui_text(prop, "IK Maximum Limits", "Maximum angles for IK Limit");
212
213         prop= RNA_def_property(srna, "ik_stiffness", PROP_FLOAT, PROP_VECTOR);
214         RNA_def_property_float_sdna(prop, NULL, "stiffness");
215         RNA_def_property_range(prop, 0.0f,0.99f);
216         RNA_def_property_ui_text(prop, "IK Stiffness", "Stiffness around the different axes.");
217
218         prop= RNA_def_property(srna, "ik_stretch", PROP_FLOAT, PROP_NONE);
219         RNA_def_property_float_sdna(prop, NULL, "ikstretch");
220         RNA_def_property_range(prop, 0.0f,1.0f);
221         RNA_def_property_ui_text(prop, "IK Stretch", "Allow scaling of the bone for IK.");
222
223         prop= RNA_def_property(srna, "custom", PROP_POINTER, PROP_NONE);
224         RNA_def_property_ui_text(prop, "Custom Object", "Object that defines custom draw type for this bone.");
225
226         prop= RNA_def_property(srna, "lock_location", PROP_BOOLEAN, PROP_VECTOR);
227         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_LOCX);
228         RNA_def_property_array(prop, 3);
229         RNA_def_property_ui_text(prop, "Lock Location", "Lock editing of location in the interface.");
230
231         prop= RNA_def_property(srna, "lock_rotation", PROP_BOOLEAN, PROP_VECTOR);
232         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_ROTX);
233         RNA_def_property_array(prop, 3);
234         RNA_def_property_ui_text(prop, "Lock Rotation", "Lock editing of rotation in the interface.");
235
236         prop= RNA_def_property(srna, "lock_scale", PROP_BOOLEAN, PROP_VECTOR);
237         RNA_def_property_boolean_sdna(prop, NULL, "protectflag", OB_LOCK_SCALEX);
238         RNA_def_property_array(prop, 3);
239         RNA_def_property_ui_text(prop, "Lock Scale", "Lock editing of scale in the interface.");
240 }
241
242 void RNA_def_pose(BlenderRNA *brna)
243 {
244         StructRNA *srna;
245         PropertyRNA *prop;
246
247         rna_def_pose_channel(brna);
248
249         srna= RNA_def_struct(brna, "Pose", NULL);
250         RNA_def_struct_sdna(srna, "bPose");
251         RNA_def_struct_ui_text(srna, "Pose", "A collection of pose channels, including settings for animating bones.");
252
253         prop= RNA_def_property(srna, "pose_channels", PROP_COLLECTION, PROP_NONE);
254         RNA_def_property_collection_sdna(prop, NULL, "chanbase", NULL);
255         RNA_def_property_struct_type(prop, "PoseChannel");
256         RNA_def_property_ui_text(prop, "Pose Channels", "Individual pose channels for the armature.");
257
258         /* commented for now... missing info... */
259         /*prop= RNA_def_property(srna, "action_groups", PROP_COLLECTION, PROP_NONE);
260         RNA_def_property_collection_sdna(prop, NULL, "agroups", NULL);
261         RNA_def_property_struct_type(prop, "ActionGroup");
262         RNA_def_property_ui_text(prop, "Action Groups", "Groups of bones.");*/
263 }
264
265 #endif