RNA: Start of RNA wrapping for Armatures
[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 static void rna_Armature_layer_set(PointerRNA *ptr, int index, int value)
37 {
38         bArmature *arm= (bArmature*)ptr->data;
39
40         if(value) arm->layer |= (1<<index);
41         else {
42                 arm->layer &= ~(1<<index);
43                 if(arm->layer == 0)
44                         arm->layer |= (1<<index);
45         }
46 }
47
48 #else
49
50 // err... bones should not be directly edited (only editbones should be...)
51 static void rna_def_bone(BlenderRNA *brna)
52 {
53         StructRNA *srna;
54         PropertyRNA *prop;
55         
56         srna= RNA_def_struct(brna, "Bone", NULL, "Bone");
57         
58 }
59
60 void rna_def_armature(BlenderRNA *brna)
61 {
62         StructRNA *srna;
63         PropertyRNA *prop;
64         
65         static EnumPropertyItem prop_drawtype_items[] = {
66                 {ARM_OCTA, "OCTAHEDRAL", "Octahedral", "Draw bones as octahedral shape (default)."},
67                 {ARM_LINE, "STICK", "Stick", "Draw bones as simple 2D lines with dots."},
68                 {ARM_B_BONE, "BBONE", "B-Bone", "Draw bones as boxes, showing subdivision and B-Splines"},
69                 {ARM_ENVELOPE, "ENVELOPE", "Envelope", "Draw bones as extruded spheres, showing defomation influence volume."},
70                 {0, NULL, NULL, NULL}};
71         static EnumPropertyItem prop_ghosttype_items[] = {
72                 {ARM_GHOST_CUR, "CURRENTFRAME", "Around Current Frame", "Draw Ghosts of poses within a fixed number of frames around the current frame."},
73                 {ARM_GHOST_RANGE, "RANGE", "In Range", "Draw Ghosts of poses within specified range."},
74                 {ARM_GHOST_KEYS, "KEYS", "On Keyframes", "Draw Ghosts of poses on Keyframes."},
75                 {0, NULL, NULL, NULL}};
76         
77         srna= RNA_def_struct(brna, "Armature", "ID", "Armature");
78         RNA_def_struct_sdna(srna, "bArmature");
79         
80         /* Collections */
81         prop= RNA_def_property(srna, "bones", PROP_COLLECTION, PROP_NONE);
82         RNA_def_property_collection_sdna(prop, NULL, "bonebase", NULL);
83         RNA_def_property_struct_type(prop, "Bone");
84         RNA_def_property_ui_text(prop, "Bones", "");
85         
86         /* Enum values */
87         prop= RNA_def_property(srna, "drawtype", PROP_ENUM, PROP_NONE);
88         RNA_def_property_enum_items(prop, prop_drawtype_items);
89         RNA_def_property_ui_text(prop, "Draw Type", "");
90         
91         prop= RNA_def_property(srna, "ghosttype", PROP_ENUM, PROP_NONE);
92         RNA_def_property_enum_items(prop, prop_drawtype_items);
93         RNA_def_property_ui_text(prop, "Ghost Drawing", "Method of Onion-skinning for active Action");
94         
95         /* Boolean values */
96                 /* layer */
97         prop= RNA_def_property(srna, "layer", PROP_BOOLEAN, PROP_NONE);
98         RNA_def_property_boolean_sdna(prop, NULL, "layer", 1);
99         RNA_def_property_array(prop, 16);
100         RNA_def_property_ui_text(prop, "Visible Layers", "Armature layer visibility.");
101         RNA_def_property_boolean_funcs(prop, NULL, "rna_Armature_layer_set");   
102         
103                 /* layer protection */
104         prop= RNA_def_property(srna, "layer_protection", PROP_BOOLEAN, PROP_NONE);
105         RNA_def_property_boolean_sdna(prop, NULL, "layer_protected", 1);
106         RNA_def_property_array(prop, 16);
107         RNA_def_property_ui_text(prop, "Layer Proxy Protection", "Protected layers in Proxy Instances are restored to Proxy settings on file reload and undo.");        
108                 
109                 /* flag */
110         prop= RNA_def_property(srna, "rest_position", PROP_BOOLEAN, PROP_NONE);
111         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_RESTPOS);
112         RNA_def_property_ui_text(prop, "Rest Position", "Show Armature in Rest Position. No posing possible.");
113         
114         prop= RNA_def_property(srna, "draw_axes", PROP_BOOLEAN, PROP_NONE);
115         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWAXES);
116         RNA_def_property_ui_text(prop, "Draw Axes", "Draw bone axes.");
117         
118         prop= RNA_def_property(srna, "draw_names", PROP_BOOLEAN, PROP_NONE);
119         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DRAWNAMES);
120         RNA_def_property_ui_text(prop, "Draw Names", "Draw bone names.");
121         
122         prop= RNA_def_property(srna, "delay_deform", PROP_BOOLEAN, PROP_NONE);
123         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_DELAYDEFORM);
124         RNA_def_property_ui_text(prop, "Delay Deform", "Don't deform children when manipulating bones in Pose Mode");
125         
126         prop= RNA_def_property(srna, "x_axis_mirror", PROP_BOOLEAN, PROP_NONE);
127         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_MIRROR_EDIT);
128         RNA_def_property_ui_text(prop, "X-Axis Mirror", "Apply changes to matching bone on opposite side of X-Axis.");
129         
130         prop= RNA_def_property(srna, "auto_ik", PROP_BOOLEAN, PROP_NONE);
131         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_AUTO_IK);
132         RNA_def_property_ui_text(prop, "Auto IK", "Add temporaral IK constraints while grabbing bones in Pose Mode.");
133         
134         prop= RNA_def_property(srna, "draw_custom_bone_shapes", PROP_BOOLEAN, PROP_NONE);
135         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ARM_NO_CUSTOM);
136         RNA_def_property_ui_text(prop, "Draw Custom Bone Shapes", "Draw bones with their custom shapes.");
137         
138         prop= RNA_def_property(srna, "draw_group_colors", PROP_BOOLEAN, PROP_NONE);
139         RNA_def_property_boolean_sdna(prop, NULL, "flag", ARM_COL_CUSTOM);
140         RNA_def_property_ui_text(prop, "Draw Bone Group Colors", "Draw bone group colors.");
141         
142         prop= RNA_def_property(srna, "ghost_only_selected", PROP_BOOLEAN, PROP_NONE);
143         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", ARM_GHOST_ONLYSEL);
144         RNA_def_property_ui_text(prop, "Draw Ghosts on Selected Keyframes Only", "");
145         
146                 /* deformflag */
147         prop= RNA_def_property(srna, "deform_vertexgroups", PROP_BOOLEAN, PROP_NONE);
148         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_VGROUP);
149         RNA_def_property_ui_text(prop, "Deform Vertex Groups", "Enable Vertex Groups when defining deform");
150         
151         prop= RNA_def_property(srna, "deform_envelope", PROP_BOOLEAN, PROP_NONE);
152         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_ENVELOPE);
153         RNA_def_property_ui_text(prop, "Deform Envelopes", "Enable Bone Envelopes when defining deform");
154         
155         prop= RNA_def_property(srna, "deform_quaternion", PROP_BOOLEAN, PROP_NONE);
156         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_QUATERNION);
157         RNA_def_property_ui_text(prop, "Use Dual Quaternion Deformation", "Enable deform rotation with Quaternions");
158         
159         prop= RNA_def_property(srna, "deform_bbone_rest", PROP_BOOLEAN, PROP_NONE);
160         RNA_def_property_boolean_sdna(prop, NULL, "deformflag", ARM_DEF_B_BONE_REST);
161         RNA_def_property_ui_text(prop, "B-Bones Deform in Rest Position", "Make B-Bones deform already in Rest Position");
162         
163         //prop= RNA_def_property(srna, "deform_invert_vertexgroups", PROP_BOOLEAN, PROP_NONE);
164         //RNA_def_property_boolean_negative_sdna(prop, NULL, "deformflag", ARM_DEF_INVERT_VGROUP);
165         //RNA_def_property_ui_text(prop, "Invert Vertex Group Influence", "Invert Vertex Group influence (only for Modifiers)");
166         
167                 /* pathflag */
168         prop= RNA_def_property(srna, "paths_show_frame_numbers", PROP_BOOLEAN, PROP_NONE);
169         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_FNUMS);
170         RNA_def_property_ui_text(prop, "Show Frame Numbers on Bone Paths", "When drawing Armature in Pose Mode, show frame numbers on Bone Paths");
171         
172         prop= RNA_def_property(srna, "paths_highlight_keyframes", PROP_BOOLEAN, PROP_NONE);
173         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_KFRAS);
174         RNA_def_property_ui_text(prop, "Highlight Keyframes on Bone Paths", "When drawing Armature in Pose Mode, emphasize position of keyframes on Bone Paths");
175         
176         prop= RNA_def_property(srna, "paths_show_keyframe_numbers", PROP_BOOLEAN, PROP_NONE);
177         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_KFNOS);
178         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");
179         
180         prop= RNA_def_property(srna, "paths_show_around_current_frame", PROP_BOOLEAN, PROP_NONE);
181         RNA_def_property_boolean_sdna(prop, NULL, "pathflag", ARM_PATH_ACFRA);
182         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");
183         
184         /* Number fields */
185         
186         
187 }
188
189 void RNA_def_armature(BlenderRNA *brna)
190 {
191         rna_def_armature(brna);
192         rna_def_bone(brna);
193 }
194
195 #endif