svn merge ^/trunk/blender -r40644:40720
[blender-staging.git] / source / blender / makesrna / intern / rna_camera.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Blender Foundation (2008).
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/makesrna/intern/rna_camera.c
26  *  \ingroup RNA
27  */
28
29
30 #include <stdlib.h>
31
32 #include "RNA_define.h"
33
34 #include "rna_internal.h"
35
36 #include "DNA_camera_types.h"
37
38 #include "BLI_math.h"
39
40 #include "WM_types.h"
41
42 #ifdef RNA_RUNTIME
43
44 #include "BKE_object.h"
45
46 /* only for rad/deg conversion! can remove later */
47 static float rna_Camera_angle_get(PointerRNA *ptr)
48 {
49         Camera *cam= ptr->id.data;
50
51         return lens_to_angle(cam->lens);
52 }
53
54 static void rna_Camera_angle_set(PointerRNA *ptr, float value)
55 {
56         Camera *cam= ptr->id.data;
57         cam->lens= angle_to_lens(value);
58 }
59
60 #else
61
62 void RNA_def_camera(BlenderRNA *brna)
63 {
64         StructRNA *srna;
65         PropertyRNA *prop;
66         static EnumPropertyItem prop_type_items[] = {
67                 {CAM_PERSP, "PERSP", 0, "Perspective", ""},
68                 {CAM_ORTHO, "ORTHO", 0, "Orthographic", ""},
69                 {0, NULL, 0, NULL, NULL}};
70         static EnumPropertyItem prop_draw_type_extra_items[] = {
71                 {CAM_DTX_CENTER, "CENTER", 0, "Center", ""},
72                 {CAM_DTX_CENTER_DIAG, "CENTER_DIAGONAL", 0, "Center Diagonal", ""},
73                 {CAM_DTX_THIRDS, "THIRDS", 0, "Thirds", ""},
74                 {CAM_DTX_GOLDEN, "GOLDEN", 0, "Golden", ""},
75                 {CAM_DTX_GOLDEN_TRI_A, "GOLDEN_TRIANGLE_A", 0, "Golden Triangle A", ""},
76                 {CAM_DTX_GOLDEN_TRI_B, "GOLDEN_TRIANGLE_B", 0, "Golden Triangle B", ""},
77                 {CAM_DTX_HARMONY_TRI_A, "HARMONY_TRIANGLE_A", 0, "Harmonious Triangle A", ""},
78                 {CAM_DTX_HARMONY_TRI_B, "HARMONY_TRIANGLE_B", 0, "Harmonious Triangle B", ""},
79                 {0, NULL, 0, NULL, NULL}};
80         static EnumPropertyItem prop_lens_unit_items[] = {
81                 {0, "MILLIMETERS", 0, "Millimeters", ""},
82                 {CAM_ANGLETOGGLE, "DEGREES", 0, "Degrees", ""},
83                 {0, NULL, 0, NULL, NULL}};
84
85         srna= RNA_def_struct(brna, "Camera", "ID");
86         RNA_def_struct_ui_text(srna, "Camera", "Camera datablock for storing camera settings");
87         RNA_def_struct_ui_icon(srna, ICON_CAMERA_DATA);
88
89         /* Enums */
90         prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
91         RNA_def_property_enum_items(prop, prop_type_items);
92         RNA_def_property_ui_text(prop, "Type", "Camera types");
93         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
94
95         prop= RNA_def_property(srna, "show_guide", PROP_ENUM, PROP_NONE);
96         RNA_def_property_enum_sdna(prop, NULL, "dtx");
97         RNA_def_property_enum_items(prop, prop_draw_type_extra_items);
98         RNA_def_property_flag(prop, PROP_ENUM_FLAG);
99         RNA_def_property_ui_text(prop, "Composition Guides",  "Draw overlay");
100         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
101         
102         /* Number values */
103
104         prop= RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_FACTOR);
105         RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
106         RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view");
107         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
108
109         prop= RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
110         RNA_def_property_float_sdna(prop, NULL, "clipsta");
111         RNA_def_property_range(prop, 0.001f, FLT_MAX);
112         RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance");
113         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
114
115         prop= RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
116         RNA_def_property_float_sdna(prop, NULL, "clipend");
117         RNA_def_property_range(prop, 1.0f, FLT_MAX);
118         RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance");
119         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
120
121         prop= RNA_def_property(srna, "lens", PROP_FLOAT, PROP_NONE);
122         RNA_def_property_float_sdna(prop, NULL, "lens");
123         RNA_def_property_range(prop, 1.0f, 5000.0f);
124         RNA_def_property_ui_text(prop, "Focal Length", "Perspective Camera lens value in millimeters");
125         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
126         
127         prop= RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
128         RNA_def_property_range(prop, M_PI * (0.367/180.0), M_PI * (172.847/180.0));
129         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
130         RNA_def_property_ui_text(prop, "Angle", "Perspective Camera lens field of view in degrees");
131         RNA_def_property_float_funcs(prop, "rna_Camera_angle_get", "rna_Camera_angle_set", NULL); /* only for deg/rad conversion */
132         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
133
134         prop= RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
135         RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
136         RNA_def_property_range(prop, 0.01f, 4000.0f);
137         RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom)");
138         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
139
140         prop= RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_DISTANCE);
141         RNA_def_property_float_sdna(prop, NULL, "drawsize");
142         RNA_def_property_range(prop, 0.01f, 1000.0f);
143         RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
144         RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View");
145         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
146
147         prop= RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
148         RNA_def_property_float_sdna(prop, NULL, "shiftx");
149         RNA_def_property_range(prop, -10.0f, 10.0f);
150         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
151         RNA_def_property_ui_text(prop, "Shift X", "Perspective Camera horizontal shift");
152         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
153
154         prop= RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
155         RNA_def_property_float_sdna(prop, NULL, "shifty");
156         RNA_def_property_range(prop, -10.0f, 10.0f);
157         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
158         RNA_def_property_ui_text(prop, "Shift Y", "Perspective Camera vertical shift");
159         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
160
161         prop= RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_DISTANCE);
162         RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
163         RNA_def_property_range(prop, 0.0f, 5000.0f);
164         RNA_def_property_ui_text(prop, "DOF Distance", "Distance to the focus point for depth of field");
165         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
166
167         /* flag */
168         prop= RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
169         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
170         RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focus point on the camera");
171         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
172
173         prop= RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
174         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
175         RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area");
176         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
177
178         prop= RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
179         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
180         RNA_def_property_ui_text(prop, "Show Passepartout", "Show a darkened overlay outside the image area in Camera view");
181         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
182
183         prop= RNA_def_property(srna, "show_title_safe", PROP_BOOLEAN, PROP_NONE);
184         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWTITLESAFE);
185         RNA_def_property_ui_text(prop, "Show Title Safe", "Show indicators for the title safe zone in Camera view");
186         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
187
188         prop= RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
189         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
190         RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view");
191         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
192
193         prop= RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
194         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
195         RNA_def_property_enum_items(prop, prop_lens_unit_items);
196         RNA_def_property_ui_text(prop, "Lens Unit", "Unit to edit lens in for the user interface");
197
198         prop= RNA_def_property(srna, "use_panorama", PROP_BOOLEAN, PROP_NONE);
199         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_PANORAMA);
200         RNA_def_property_ui_text(prop, "Panorama", "Render the scene with a cylindrical camera for pseudo-fisheye lens effects");
201         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
202
203         /* pointers */
204         rna_def_animdata_common(srna);
205
206         prop= RNA_def_property(srna, "dof_object", PROP_POINTER, PROP_NONE);
207         RNA_def_property_struct_type(prop, "Object");
208         RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
209         RNA_def_property_flag(prop, PROP_EDITABLE);
210         RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define the depth of field focal point");
211         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
212
213         /* Camera API */
214         RNA_api_camera(srna);
215 }
216
217 #endif
218