RNA - Wrapped a few more Armature/Bone settings
[blender.git] / source / blender / makesrna / intern / rna_armature.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), 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_armature_types.h"
33
34 #ifdef RNA_RUNTIME
35
36
37 static void rna_Bone_layer_set(PointerRNA *ptr, int index, int value)
38 {
39         Bone *bone= (Bone*)ptr->data;
40
41         if(value) bone->layer |= (1<<index);
42         else {
43                 bone->layer &= ~(1<<index);
44                 if(bone->layer == 0)
45                         bone->layer |= (1<<index);
46         }
47 }
48
49
50 static void rna_Armature_layer_set(PointerRNA *ptr, int index, int value)
51 {
52         bArmature *arm= (bArmature*)ptr->data;
53
54         if(value) arm->layer |= (1<<index);
55         else {
56                 arm->layer &= ~(1<<index);
57                 if(arm->layer == 0)
58                         arm->layer |= (1<<index);
59         }
60 }
61
62 static void rna_Armature_ghost_start_frame_set(PointerRNA *ptr, int value)
63 {
64         bArmature *data= (bArmature*)ptr->data;
65         CLAMP(value, 1, data->ghostef);
66         data->ghostsf= value;
67 }
68
69 static void rna_Armature_ghost_end_frame_set(PointerRNA *ptr, int value)
70 {
71         bArmature *data= (bArmature*)ptr->data;
72         CLAMP(value, data->ghostsf, 300000);
73         data->ghostef= value;
74 }
75
76 #else
77
78 // err... bones should not be directly edited (only editbones should be...)
79 static void rna_def_bone(BlenderRNA *brna)
80 {
81         StructRNA *srna;
82         PropertyRNA *prop;
83         
84         srna= RNA_def_struct(brna, "Bone", NULL, "Bone");
85         
86         /* strings */
87         prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
88         RNA_def_property_flag(prop, PROP_NOT_EDITABLE); /* must be unique */
89         RNA_def_property_ui_text(prop, "Name", "");
90         RNA_def_struct_name_property(srna, prop);
91         
92         /* flags */
93                 /* layer */
94         prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_NONE);
95         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
96         RNA_def_property_array(prop, 16);
97         RNA_def_property_ui_text(prop, "Bone Layers", "Layers bone exists in");
98         RNA_def_property_boolean_funcs(prop, NULL, "rna_Bone_layer_set");       
99 }
100
101 void rna_def_armature(BlenderRNA *brna)
102 {
103         StructRNA *srna;
104         PropertyRNA *prop;
105         
106         static EnumPropertyItem prop_drawtype_items[] = {
107                 {ARM_OCTA, "OCTAHEDRAL", "Octahedral", "Draw bones as octahedral shape (default)."},
108                 {ARM_LINE, "STICK", "Stick", "Draw bones as simple 2D lines with dots."},
109                 {ARM_B_BONE, "BBONE", "B-Bone", "Draw bones as boxes, showing subdivision and B-Splines"},
110                 {ARM_ENVELOPE, "ENVELOPE", "Envelope", "Draw bones as extruded spheres, showing defomation influence volume."},
111                 {0, NULL, NULL, NULL}};
112         static EnumPropertyItem prop_ghosttype_items[] = {
113                 {ARM_GHOST_CUR, "CURRENTFRAME", "Around Current Frame", "Draw Ghosts of poses within a fixed number of frames around the current frame."},
114                 {ARM_GHOST_RANGE, "RANGE", "In Range", "Draw Ghosts of poses within specified range."},
115                 {ARM_GHOST_KEYS, "KEYS", "On Keyframes", "Draw Ghosts of poses on Keyframes."},
116                 {0, NULL, NULL, NULL}};
117         
118         srna= RNA_def_struct(brna, "Armature", "ID", "Armature");
119         RNA_def_struct_sdna(srna, "bArmature");
120         
121         /* Collections */
122         prop= RNA_def_property(srna, "bones", PROP_COLLECTION, PROP_NONE);
123         RNA_def_property_collection_sdna(prop, NULL, "bonebase", NULL);
124         RNA_def_property_struct_type(prop, "Bone");
125         RNA_def_property_ui_text(prop, "Bones", "");
126         
127         /* Enum values */
128         prop= RNA_def_property(srna, "drawtype", PROP_ENUM, PROP_NONE);
129         RNA_def_property_enum_items(prop, prop_drawtype_items);
130         RNA_def_property_ui_text(prop, "Draw Type", "");
131         
132         prop= RNA_def_property(srna, "ghosttype", PROP_ENUM, PROP_NONE);
133         RNA_def_property_enum_items(prop, prop_ghosttype_items);
134         RNA_def_property_ui_text(prop, "Ghost Drawing", "Method of Onion-skinning for active Action");
135         
136         /* Boolean values */
137                 /* layer */
138         prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_NONE);
139         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
140         RNA_def_property_array(prop, 16);
141         RNA_def_property_ui_text(prop, "Visible Layers", "Armature layer visibility.");
142         RNA_def_property_boolean_funcs(prop, NULL, "rna_Armature_layer_set");
143         
144                 /* layer protection */
145         prop= RNA_def_property(srna, "layer_protection", PROP_BOOLEAN, PROP_NONE);
146         RNA_def_property_boolean_sdna(prop, NULL, "layer_protected", 1);
147         RNA_def_property_array(prop, 16);
148         RNA_def_property_ui_text(prop, "Layer Proxy Protection", "Protected layers in Proxy Instances are restored to Proxy settings on file reload and undo.");        
149                 
150                 /* flag */
151         prop= RNA_def_property(srna, "rest_position", PROP_BOOLEAN, PROP_NONE);
152         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_RESTPOS);
153         RNA_def_property_ui_text(prop, "Rest Position", "Show Armature in Rest Position. No posing possible.");
154         
155         prop= RNA_def_property(srna, "draw_axes", PROP_BOOLEAN, PROP_NONE);
156         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWAXES);
157         RNA_def_property_ui_text(prop, "Draw Axes", "Draw bone axes.");
158         
159         prop= RNA_def_property(srna, "draw_names", PROP_BOOLEAN, PROP_NONE);
160         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWNAMES);
161         RNA_def_property_ui_text(prop, "Draw Names", "Draw bone names.");
162         
163         prop= RNA_def_property(srna, "delay_deform", PROP_BOOLEAN, PROP_NONE);
164         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DELAYDEFORM);
165         RNA_def_property_ui_text(prop, "Delay Deform", "Don't deform children when manipulating bones in Pose Mode");
166         
167         prop= RNA_def_property(srna, "x_axis_mirror", PROP_BOOLEAN, PROP_NONE);
168         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_MIRROR_EDIT);
169         RNA_def_property_ui_text(prop, "X-Axis Mirror", "Apply changes to matching bone on opposite side of X-Axis.");
170         
171         prop= RNA_def_property(srna, "auto_ik", PROP_BOOLEAN, PROP_NONE);
172         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_AUTO_IK);
173         RNA_def_property_ui_text(prop, "Auto IK", "Add temporaral IK constraints while grabbing bones in Pose Mode.");
174         
175         prop= RNA_def_property(srna, "draw_custom_bone_shapes", PROP_BOOLEAN, PROP_NONE);
176         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ARM_NO_CUSTOM);
177         RNA_def_property_ui_text(prop, "Draw Custom Bone Shapes", "Draw bones with their custom shapes.");
178         
179         prop= RNA_def_property(srna, "draw_group_colors", PROP_BOOLEAN, PROP_NONE);
180         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_COL_CUSTOM);
181         RNA_def_property_ui_text(prop, "Draw Bone Group Colors", "Draw bone group colors.");
182         
183         prop= RNA_def_property(srna, "ghost_only_selected", PROP_BOOLEAN, PROP_NONE);
184         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ARM_GHOST_ONLYSEL);
185         RNA_def_property_ui_text(prop, "Draw Ghosts on Selected Keyframes Only", "");
186         
187                 /* deformflag */
188         prop= RNA_def_property(srna, "deform_vertexgroups", PROP_BOOLEAN, PROP_NONE);
189         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_VGROUP);
190         RNA_def_property_ui_text(prop, "Deform Vertex Groups", "Enable Vertex Groups when defining deform");
191         
192         prop= RNA_def_property(srna, "deform_envelope", PROP_BOOLEAN, PROP_NONE);
193         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_ENVELOPE);
194         RNA_def_property_ui_text(prop, "Deform Envelopes", "Enable Bone Envelopes when defining deform");
195         
196         prop= RNA_def_property(srna, "deform_quaternion", PROP_BOOLEAN, PROP_NONE);
197         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_QUATERNION);
198         RNA_def_property_ui_text(prop, "Use Dual Quaternion Deformation", "Enable deform rotation with Quaternions");
199         
200         prop= RNA_def_property(srna, "deform_bbone_rest", PROP_BOOLEAN, PROP_NONE);
201         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_B_BONE_REST);
202         RNA_def_property_ui_text(prop, "B-Bones Deform in Rest Position", "Make B-Bones deform already in Rest Position");
203         
204         //prop= RNA_def_property(srna, "deform_invert_vertexgroups", PROP_BOOLEAN, PROP_NONE);
205         //RNA_def_property_boolean_negative_sdna(prop, NULL, "deformflag", ARM_DEF_INVERT_VGROUP);
206         //RNA_def_property_ui_text(prop, "Invert Vertex Group Influence", "Invert Vertex Group influence (only for Modifiers)");
207         
208                 /* pathflag */
209         prop= RNA_def_property(srna, "paths_show_frame_numbers", PROP_BOOLEAN, PROP_NONE);
210         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_FNUMS);
211         RNA_def_property_ui_text(prop, "Show Frame Numbers on Bone Paths", "When drawing Armature in Pose Mode, show frame numbers on Bone Paths");
212         
213         prop= RNA_def_property(srna, "paths_highlight_keyframes", PROP_BOOLEAN, PROP_NONE);
214         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_KFRAS);
215         RNA_def_property_ui_text(prop, "Highlight Keyframes on Bone Paths", "When drawing Armature in Pose Mode, emphasize position of keyframes on Bone Paths");
216         
217         prop= RNA_def_property(srna, "paths_show_keyframe_numbers", PROP_BOOLEAN, PROP_NONE);
218         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_KFNOS);
219         RNA_def_property_ui_text(prop, "Show frame numbers of Keyframes on Bone Paths", "When drawing Armature in Pose Mode, show frame numbers of Keyframes on Bone Paths");
220         
221         prop= RNA_def_property(srna, "paths_show_around_current_frame", PROP_BOOLEAN, PROP_NONE);
222         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_ACFRA);
223         RNA_def_property_ui_text(prop, "Only show Bone Paths around current frame", "When drawing Armature in Pose Mode, only show section of Bone Paths that falls around current frame");
224         
225         prop= RNA_def_property(srna, "paths_calculate_head_positions", PROP_BOOLEAN, PROP_NONE);
226         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_HEADS);
227         RNA_def_property_ui_text(prop, "Bone Paths Use Heads", "When calculating Bone Paths, use Head locations instead of Tips");
228         
229         /* Number fields */
230                 /* ghost/onionskining settings */
231         prop= RNA_def_property(srna, "ghost_step", PROP_INT, PROP_NONE);
232         RNA_def_property_int_sdna(prop, NULL, "ghostep");
233         RNA_def_property_range(prop, 0, 30);
234         RNA_def_property_ui_text(prop, "Ghost Step", "Number of frame steps on either side of current frame to show as ghosts (only for 'Around Current Frame' Onion-skining method).");
235         
236         prop= RNA_def_property(srna, "ghost_size", PROP_INT, PROP_NONE);
237         RNA_def_property_int_sdna(prop, NULL, "ghostsize");
238         RNA_def_property_range(prop, 0, 30);
239         RNA_def_property_ui_text(prop, "Ghost Frame Step", "Frame step for Ghosts (not for 'On Keyframes' Onion-skining method).");
240         
241         prop= RNA_def_property(srna, "ghost_start_frame", PROP_INT, PROP_NONE);
242         RNA_def_property_int_sdna(prop, NULL, "ghostsf");
243         RNA_def_property_int_funcs(prop, NULL, "rna_Armature_ghost_start_frame_set", NULL);
244         RNA_def_property_ui_text(prop, "Ghost Start Frame", "Starting frame of range of Ghosts to display (not for 'Around Current Frame' Onion-skinning method).");
245         
246         prop= RNA_def_property(srna, "ghost_end_frame", PROP_INT, PROP_NONE);
247         RNA_def_property_int_sdna(prop, NULL, "ghostef");
248         RNA_def_property_int_funcs(prop, NULL, "rna_Armature_ghost_end_frame_set", NULL);
249         RNA_def_property_ui_text(prop, "Ghost End Frame", "End frame of range of Ghosts to display (not for 'Around Current Frame' Onion-skinning method).");
250         
251                 /* bone path settings */
252         prop= RNA_def_property(srna, "path_size", PROP_INT, PROP_NONE);
253         RNA_def_property_int_sdna(prop, NULL, "pathsize");
254         RNA_def_property_range(prop, 0, 30);
255         RNA_def_property_ui_text(prop, "Path Frame Step", "Number of frames between 'dots' on Bone Paths (when drawing).");
256 }
257
258 void RNA_def_armature(BlenderRNA *brna)
259 {
260         rna_def_armature(brna);
261         rna_def_bone(brna);
262 }
263
264 #endif