084e299140d8fca6b083d257fb739c63a2fc0250
[blender-staging.git] / source / blender / makesrna / intern / rna_camera.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Blender Foundation (2008).
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_camera.c
24  *  \ingroup RNA
25  */
26
27
28 #include <stdlib.h>
29
30 #include "RNA_define.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_camera_types.h"
35
36 #include "BLI_math.h"
37
38 #include "WM_types.h"
39
40 #ifdef RNA_RUNTIME
41
42 #include "BKE_camera.h"
43 #include "BKE_object.h"
44 #include "BKE_depsgraph.h"
45
46 static float rna_Camera_angle_get(PointerRNA *ptr)
47 {
48         Camera *cam = ptr->id.data;
49         float sensor = camera_sensor_size(cam->sensor_fit, cam->sensor_x, cam->sensor_y);
50         return focallength_to_fov(cam->lens, sensor);
51 }
52
53 static void rna_Camera_angle_set(PointerRNA *ptr, float value)
54 {
55         Camera *cam = ptr->id.data;
56         float sensor = camera_sensor_size(cam->sensor_fit, cam->sensor_x, cam->sensor_y);
57         cam->lens = fov_to_focallength(value, sensor);
58 }
59
60 static float rna_Camera_angle_x_get(PointerRNA *ptr)
61 {
62         Camera *cam = ptr->id.data;
63         return focallength_to_fov(cam->lens, cam->sensor_x);
64 }
65
66 static void rna_Camera_angle_x_set(PointerRNA *ptr, float value)
67 {
68         Camera *cam = ptr->id.data;
69         cam->lens = fov_to_focallength(value, cam->sensor_x);
70 }
71
72 static float rna_Camera_angle_y_get(PointerRNA *ptr)
73 {
74         Camera *cam = ptr->id.data;
75         return focallength_to_fov(cam->lens, cam->sensor_y);
76 }
77
78 static void rna_Camera_angle_y_set(PointerRNA *ptr, float value)
79 {
80         Camera *cam = ptr->id.data;
81         cam->lens = fov_to_focallength(value, cam->sensor_y);
82 }
83
84 static void rna_Camera_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
85 {
86         Camera *camera = (Camera*)ptr->id.data;
87
88         DAG_id_tag_update(&camera->id, 0);
89 }
90
91 #else
92
93 void RNA_def_camera(BlenderRNA *brna)
94 {
95         StructRNA *srna;
96         PropertyRNA *prop;
97         static EnumPropertyItem prop_type_items[] = {
98                 {CAM_PERSP, "PERSP", 0, "Perspective", ""},
99                 {CAM_ORTHO, "ORTHO", 0, "Orthographic", ""},
100                 {0, NULL, 0, NULL, NULL}};
101         static EnumPropertyItem prop_draw_type_extra_items[] = {
102                 {CAM_DTX_CENTER, "CENTER", 0, "Center", ""},
103                 {CAM_DTX_CENTER_DIAG, "CENTER_DIAGONAL", 0, "Center Diagonal", ""},
104                 {CAM_DTX_THIRDS, "THIRDS", 0, "Thirds", ""},
105                 {CAM_DTX_GOLDEN, "GOLDEN", 0, "Golden", ""},
106                 {CAM_DTX_GOLDEN_TRI_A, "GOLDEN_TRIANGLE_A", 0, "Golden Triangle A", ""},
107                 {CAM_DTX_GOLDEN_TRI_B, "GOLDEN_TRIANGLE_B", 0, "Golden Triangle B", ""},
108                 {CAM_DTX_HARMONY_TRI_A, "HARMONY_TRIANGLE_A", 0, "Harmonious Triangle A", ""},
109                 {CAM_DTX_HARMONY_TRI_B, "HARMONY_TRIANGLE_B", 0, "Harmonious Triangle B", ""},
110                 {0, NULL, 0, NULL, NULL}};
111         static EnumPropertyItem prop_lens_unit_items[] = {
112                 {0, "MILLIMETERS", 0, "Millimeters", ""},
113                 {CAM_ANGLETOGGLE, "DEGREES", 0, "Degrees", ""},
114                 {0, NULL, 0, NULL, NULL}};
115         static EnumPropertyItem sensor_fit_items[] = {
116                 {CAMERA_SENSOR_FIT_AUTO, "AUTO", 0, "Auto", "Fit to the sensor width or height depending on image resolution"},
117                 {CAMERA_SENSOR_FIT_HOR, "HORIZONTAL", 0, "Horizontal", "Fit to the sensor width"},
118                 {CAMERA_SENSOR_FIT_VERT, "VERTICAL", 0, "Vertical", "Fit to the sensor height"},
119                 {0, NULL, 0, NULL, NULL}};
120
121         srna = RNA_def_struct(brna, "Camera", "ID");
122         RNA_def_struct_ui_text(srna, "Camera", "Camera datablock for storing camera settings");
123         RNA_def_struct_ui_icon(srna, ICON_CAMERA_DATA);
124
125         /* Enums */
126         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
127         RNA_def_property_enum_items(prop, prop_type_items);
128         RNA_def_property_ui_text(prop, "Type", "Camera types");
129         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
130
131         prop = RNA_def_property(srna, "show_guide", PROP_ENUM, PROP_NONE);
132         RNA_def_property_enum_sdna(prop, NULL, "dtx");
133         RNA_def_property_enum_items(prop, prop_draw_type_extra_items);
134         RNA_def_property_flag(prop, PROP_ENUM_FLAG);
135         RNA_def_property_ui_text(prop, "Composition Guides",  "Draw overlay");
136         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
137
138         prop = RNA_def_property(srna, "sensor_fit", PROP_ENUM, PROP_NONE);
139         RNA_def_property_enum_sdna(prop, NULL, "sensor_fit");
140         RNA_def_property_enum_items(prop, sensor_fit_items);
141         RNA_def_property_ui_text(prop, "Sensor Fit", "Method to fit image and field of view angle inside the sensor");
142         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
143
144         /* Number values */
145
146         prop = RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_FACTOR);
147         RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
148         RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view");
149         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
150
151         prop = RNA_def_property(srna, "angle_x", PROP_FLOAT, PROP_ANGLE);
152         RNA_def_property_range(prop, M_PI * (0.367/180.0), M_PI * (172.847/180.0));
153         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
154         RNA_def_property_ui_text(prop, "Horizontal FOV", "Camera lens horizontal field of view in degrees");
155         RNA_def_property_float_funcs(prop, "rna_Camera_angle_x_get", "rna_Camera_angle_x_set", NULL);
156         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
157
158         prop = RNA_def_property(srna, "angle_y", PROP_FLOAT, PROP_ANGLE);
159         RNA_def_property_range(prop, M_PI * (0.367/180.0), M_PI * (172.847/180.0));
160         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
161         RNA_def_property_ui_text(prop, "Vertical FOV", "Camera lens vertical field of view in degrees");
162         RNA_def_property_float_funcs(prop, "rna_Camera_angle_y_get", "rna_Camera_angle_y_set", NULL);
163         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
164
165         prop = RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
166         RNA_def_property_range(prop, M_PI * (0.367/180.0), M_PI * (172.847/180.0));
167         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
168         RNA_def_property_ui_text(prop, "Field of View", "Camera lens field of view in degrees");
169         RNA_def_property_float_funcs(prop, "rna_Camera_angle_get", "rna_Camera_angle_set", NULL);
170         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
171
172         prop = RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
173         RNA_def_property_float_sdna(prop, NULL, "clipsta");
174         RNA_def_property_range(prop, 0.001f, FLT_MAX);
175         RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance");
176         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
177
178         prop = RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
179         RNA_def_property_float_sdna(prop, NULL, "clipend");
180         RNA_def_property_range(prop, 1.0f, FLT_MAX);
181         RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance");
182         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
183
184         prop = RNA_def_property(srna, "lens", PROP_FLOAT, PROP_NONE);
185         RNA_def_property_float_sdna(prop, NULL, "lens");
186         RNA_def_property_range(prop, 1.0f, 5000.0f);
187         RNA_def_property_ui_text(prop, "Focal Length", "Perspective Camera lens value in millimeters");
188         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
189
190         prop = RNA_def_property(srna, "sensor_width", PROP_FLOAT, PROP_NONE);
191         RNA_def_property_float_sdna(prop, NULL, "sensor_x");
192         RNA_def_property_range(prop, 1.0f, FLT_MAX);
193         RNA_def_property_ui_range(prop, 1.0f, 100.f, 1, 2);
194         RNA_def_property_ui_text(prop, "Sensor Width", "Horizontal size of the image sensor area in millimeters");
195         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
196
197         prop = RNA_def_property(srna, "sensor_height", PROP_FLOAT, PROP_NONE);
198         RNA_def_property_float_sdna(prop, NULL, "sensor_y");
199         RNA_def_property_range(prop, 1.0f, FLT_MAX);
200         RNA_def_property_ui_range(prop, 1.0f, 100.f, 1, 2);
201         RNA_def_property_ui_text(prop, "Sensor Height", "Vertical size of the image sensor area in millimeters");
202         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
203
204         prop = RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
205         RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
206         RNA_def_property_range(prop, 0.01f, 4000.0f);
207         RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom)");
208         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
209
210         prop = RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_DISTANCE);
211         RNA_def_property_float_sdna(prop, NULL, "drawsize");
212         RNA_def_property_range(prop, 0.01f, 1000.0f);
213         RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
214         RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View");
215         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
216
217         prop = RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
218         RNA_def_property_float_sdna(prop, NULL, "shiftx");
219         RNA_def_property_range(prop, -10.0f, 10.0f);
220         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
221         RNA_def_property_ui_text(prop, "Shift X", "Perspective Camera horizontal shift");
222         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
223
224         prop = RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
225         RNA_def_property_float_sdna(prop, NULL, "shifty");
226         RNA_def_property_range(prop, -10.0f, 10.0f);
227         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
228         RNA_def_property_ui_text(prop, "Shift Y", "Perspective Camera vertical shift");
229         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, "rna_Camera_update");
230
231         prop = RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_DISTANCE);
232         RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
233         RNA_def_property_range(prop, 0.0f, 5000.0f);
234         RNA_def_property_ui_text(prop, "DOF Distance", "Distance to the focus point for depth of field");
235         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
236
237         /* flag */
238         prop = RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
239         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
240         RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focus point on the camera");
241         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
242
243         prop = RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
244         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
245         RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area");
246         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
247
248         prop = RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
249         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
250         RNA_def_property_ui_text(prop, "Show Passepartout", "Show a darkened overlay outside the image area in Camera view");
251         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
252
253         prop = RNA_def_property(srna, "show_title_safe", PROP_BOOLEAN, PROP_NONE);
254         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWTITLESAFE);
255         RNA_def_property_ui_text(prop, "Show Title Safe", "Show indicators for the title safe zone in Camera view");
256         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
257
258         prop = RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
259         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
260         RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view");
261         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
262
263         prop = RNA_def_property(srna, "show_sensor", PROP_BOOLEAN, PROP_NONE);
264         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWSENSOR);
265         RNA_def_property_ui_text(prop, "Show Sensor Size", "Show sensor size (film gate) in Camera view");
266         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
267
268         prop = RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
269         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
270         RNA_def_property_enum_items(prop, prop_lens_unit_items);
271         RNA_def_property_ui_text(prop, "Lens Unit", "Unit to edit lens in for the user interface");
272
273         prop = RNA_def_property(srna, "use_panorama", PROP_BOOLEAN, PROP_NONE);
274         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_PANORAMA);
275         RNA_def_property_ui_text(prop, "Panorama", "Render the scene with a cylindrical camera for pseudo-fisheye lens effects");
276         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
277
278         /* pointers */
279         rna_def_animdata_common(srna);
280
281         prop = RNA_def_property(srna, "dof_object", PROP_POINTER, PROP_NONE);
282         RNA_def_property_struct_type(prop, "Object");
283         RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
284         RNA_def_property_flag(prop, PROP_EDITABLE);
285         RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define the depth of field focal point");
286         RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);
287
288         /* Camera API */
289         RNA_api_camera(srna);
290 }
291
292 #endif
293