Merge branch 'master' into blender2.8
[blender.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 #include <stdlib.h>
28
29 #include "DNA_camera_types.h"
30
31 #include "BLI_math.h"
32
33 #include "RNA_access.h"
34 #include "RNA_define.h"
35
36 #include "rna_internal.h"
37
38 #include "WM_api.h"
39 #include "WM_types.h"
40
41 #ifdef RNA_RUNTIME
42
43 #include "BKE_camera.h"
44 #include "BKE_object.h"
45 #include "BKE_sequencer.h"
46
47 #include "DEG_depsgraph.h"
48 #include "DEG_depsgraph_build.h"
49
50 static float rna_Camera_draw_size_get(PointerRNA *ptr)
51 {
52         Camera *cam = ptr->id.data;
53         return cam->drawsize * 2.0f;
54 }
55
56 static void rna_Camera_draw_size_set(PointerRNA *ptr, float value)
57 {
58         Camera *cam = ptr->id.data;
59         cam->drawsize = value / 2.0f;
60 }
61
62 static float rna_Camera_angle_get(PointerRNA *ptr)
63 {
64         Camera *cam = ptr->id.data;
65         float sensor = BKE_camera_sensor_size(cam->sensor_fit, cam->sensor_x, cam->sensor_y);
66         return focallength_to_fov(cam->lens, sensor);
67 }
68
69 static void rna_Camera_angle_set(PointerRNA *ptr, float value)
70 {
71         Camera *cam = ptr->id.data;
72         float sensor = BKE_camera_sensor_size(cam->sensor_fit, cam->sensor_x, cam->sensor_y);
73         cam->lens = fov_to_focallength(value, sensor);
74 }
75
76 static float rna_Camera_angle_x_get(PointerRNA *ptr)
77 {
78         Camera *cam = ptr->id.data;
79         return focallength_to_fov(cam->lens, cam->sensor_x);
80 }
81
82 static void rna_Camera_angle_x_set(PointerRNA *ptr, float value)
83 {
84         Camera *cam = ptr->id.data;
85         cam->lens = fov_to_focallength(value, cam->sensor_x);
86 }
87
88 static float rna_Camera_angle_y_get(PointerRNA *ptr)
89 {
90         Camera *cam = ptr->id.data;
91         return focallength_to_fov(cam->lens, cam->sensor_y);
92 }
93
94 static void rna_Camera_angle_y_set(PointerRNA *ptr, float value)
95 {
96         Camera *cam = ptr->id.data;
97         cam->lens = fov_to_focallength(value, cam->sensor_y);
98 }
99
100 static void rna_Camera_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
101 {
102         Camera *camera = (Camera *)ptr->id.data;
103
104         DEG_id_tag_update(&camera->id, 0);
105 }
106
107 static void rna_Camera_dependency_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
108 {
109         Camera *camera = (Camera *)ptr->id.data;
110         DEG_relations_tag_update(bmain);
111         DEG_id_tag_update(&camera->id, 0);
112 }
113
114 static CameraBGImage *rna_Camera_background_images_new(Camera *cam)
115 {
116         CameraBGImage *bgpic = BKE_camera_background_image_new(cam);
117
118         WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
119
120         return bgpic;
121 }
122
123 static void rna_Camera_background_images_remove(Camera *cam, ReportList *reports, PointerRNA *bgpic_ptr)
124 {
125         CameraBGImage *bgpic = bgpic_ptr->data;
126         if (BLI_findindex(&cam->bg_images, bgpic) == -1) {
127                 BKE_report(reports, RPT_ERROR, "Background image cannot be removed");
128         }
129
130         BKE_camera_background_image_remove(cam, bgpic);
131         RNA_POINTER_INVALIDATE(bgpic_ptr);
132
133         WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
134 }
135
136 static void rna_Camera_background_images_clear(Camera *cam)
137 {
138         BKE_camera_background_image_clear(cam);
139
140         WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
141 }
142
143 static void rna_Camera_dof_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *UNUSED(ptr))
144 {
145         /* TODO(sergey): Can be more selective here. */
146         BKE_sequencer_cache_cleanup();
147         BKE_sequencer_preprocessed_cache_cleanup();
148         WM_main_add_notifier(NC_SCENE | ND_SEQUENCER, scene);
149 }
150
151 #else
152
153 static void rna_def_camera_background_image(BlenderRNA *brna)
154 {
155         StructRNA *srna;
156         PropertyRNA *prop;
157
158         static const EnumPropertyItem bgpic_source_items[] = {
159                 {CAM_BGIMG_SOURCE_IMAGE, "IMAGE", 0, "Image", ""},
160                 {CAM_BGIMG_SOURCE_MOVIE, "MOVIE_CLIP", 0, "Movie Clip", ""},
161                 {0, NULL, 0, NULL, NULL}
162         };
163
164         static const EnumPropertyItem bgpic_camera_frame_items[] = {
165                 {0, "STRETCH", 0, "Stretch", ""},
166                 {CAM_BGIMG_FLAG_CAMERA_ASPECT, "FIT", 0, "Fit", ""},
167                 {CAM_BGIMG_FLAG_CAMERA_ASPECT | CAM_BGIMG_FLAG_CAMERA_CROP, "CROP", 0, "Crop", ""},
168                 {0, NULL, 0, NULL, NULL}
169         };
170
171         static const EnumPropertyItem bgpic_display_depth_items[] = {
172                 {0, "BACK", 0, "Back", ""},
173                 {CAM_BGIMG_FLAG_FOREGROUND, "FRONT", 0, "Front", ""},
174                 {0, NULL, 0, NULL, NULL}
175         };
176
177         srna = RNA_def_struct(brna, "CameraBackgroundImage", NULL);
178         RNA_def_struct_sdna(srna, "CameraBGImage");
179         RNA_def_struct_ui_text(srna, "Background Image", "Image and settings for display in the 3D View background");
180
181         prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
182         RNA_def_property_enum_sdna(prop, NULL, "source");
183         RNA_def_property_enum_items(prop, bgpic_source_items);
184         RNA_def_property_ui_text(prop, "Background Source", "Data source used for background");
185         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
186
187         prop = RNA_def_property(srna, "image", PROP_POINTER, PROP_NONE);
188         RNA_def_property_pointer_sdna(prop, NULL, "ima");
189         RNA_def_property_ui_text(prop, "Image", "Image displayed and edited in this space");
190         RNA_def_property_flag(prop, PROP_EDITABLE);
191         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
192
193         prop = RNA_def_property(srna, "clip", PROP_POINTER, PROP_NONE);
194         RNA_def_property_pointer_sdna(prop, NULL, "clip");
195         RNA_def_property_ui_text(prop, "MovieClip", "Movie clip displayed and edited in this space");
196         RNA_def_property_flag(prop, PROP_EDITABLE);
197         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
198
199         prop = RNA_def_property(srna, "image_user", PROP_POINTER, PROP_NONE);
200         RNA_def_property_flag(prop, PROP_NEVER_NULL);
201         RNA_def_property_pointer_sdna(prop, NULL, "iuser");
202         RNA_def_property_ui_text(prop, "Image User",
203                                  "Parameters defining which layer, pass and frame of the image is displayed");
204         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
205
206         prop = RNA_def_property(srna, "clip_user", PROP_POINTER, PROP_NONE);
207         RNA_def_property_flag(prop, PROP_NEVER_NULL);
208         RNA_def_property_struct_type(prop, "MovieClipUser");
209         RNA_def_property_pointer_sdna(prop, NULL, "cuser");
210         RNA_def_property_ui_text(prop, "Clip User", "Parameters defining which frame of the movie clip is displayed");
211         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
212
213         prop = RNA_def_property(srna, "offset", PROP_FLOAT, PROP_XYZ);
214         RNA_def_property_float_sdna(prop, NULL, "offset");
215         RNA_def_property_ui_text(prop, "Offset", "");
216         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
217
218         prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_FACTOR);
219         RNA_def_property_float_sdna(prop, NULL, "scale");
220         RNA_def_property_ui_text(prop, "Scale", "Scale the background image");
221         RNA_def_property_range(prop, 0.0, FLT_MAX);
222         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
223
224         prop = RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ANGLE);
225         RNA_def_property_float_sdna(prop, NULL, "rotation");
226         RNA_def_property_ui_text(prop, "Rotation", "Rotation for the background image (ortho view only)");
227         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
228
229         prop = RNA_def_property(srna, "use_flip_x", PROP_BOOLEAN, PROP_NONE);
230         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FLIP_X);
231         RNA_def_property_ui_text(prop, "Flip Horizontally", "Flip the background image horizontally");
232         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
233
234         prop = RNA_def_property(srna, "use_flip_y", PROP_BOOLEAN, PROP_NONE);
235         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FLIP_Y);
236         RNA_def_property_ui_text(prop, "Flip Vertically", "Flip the background image vertically");
237         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
238
239         prop = RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
240         RNA_def_property_float_sdna(prop, NULL, "alpha");
241         RNA_def_property_ui_text(prop, "Alpha", "Image opacity to blend the image against the background color");
242         RNA_def_property_range(prop, 0.0, 1.0);
243         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
244
245         prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
246         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_EXPANDED);
247         RNA_def_property_ui_text(prop, "Show Expanded", "Show the expanded in the user interface");
248         RNA_def_property_ui_icon(prop, ICON_DISCLOSURE_TRI_RIGHT, 1);
249
250         prop = RNA_def_property(srna, "use_camera_clip", PROP_BOOLEAN, PROP_NONE);
251         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_CAMERACLIP);
252         RNA_def_property_ui_text(prop, "Camera Clip", "Use movie clip from active scene camera");
253         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
254
255         prop = RNA_def_property(srna, "show_background_image", PROP_BOOLEAN, PROP_NONE);
256         RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_DISABLED);
257         RNA_def_property_ui_text(prop, "Show Background Image", "Show this image as background");
258         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
259
260         prop = RNA_def_property(srna, "show_on_foreground", PROP_BOOLEAN, PROP_NONE);
261         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FOREGROUND);
262         RNA_def_property_ui_text(prop, "Show On Foreground", "Show this image in front of objects in viewport");
263         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
264
265         /* expose 1 flag as a enum of 2 items */
266         prop = RNA_def_property(srna, "display_depth", PROP_ENUM, PROP_NONE);
267         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
268         RNA_def_property_enum_items(prop, bgpic_display_depth_items);
269         RNA_def_property_ui_text(prop, "Depth", "Display under or over everything");
270         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
271
272         /* expose 2 flags as a enum of 3 items */
273         prop = RNA_def_property(srna, "frame_method", PROP_ENUM, PROP_NONE);
274         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
275         RNA_def_property_enum_items(prop, bgpic_camera_frame_items);
276         RNA_def_property_ui_text(prop, "Frame Method", "How the image fits in the camera frame");
277         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
278 }
279
280
281 static void rna_def_camera_background_images(BlenderRNA *brna, PropertyRNA *cprop)
282 {
283         StructRNA *srna;
284         FunctionRNA *func;
285         PropertyRNA *parm;
286
287         RNA_def_property_srna(cprop, "CameraBackgroundImages");
288         srna = RNA_def_struct(brna, "CameraBackgroundImages", NULL);
289         RNA_def_struct_sdna(srna, "Camera");
290         RNA_def_struct_ui_text(srna, "Background Images", "Collection of background images");
291
292         func = RNA_def_function(srna, "new", "rna_Camera_background_images_new");
293         RNA_def_function_ui_description(func, "Add new background image");
294         parm = RNA_def_pointer(func, "image", "CameraBackgroundImage", "", "Image displayed as viewport background");
295         RNA_def_function_return(func, parm);
296
297         func = RNA_def_function(srna, "remove", "rna_Camera_background_images_remove");
298         RNA_def_function_ui_description(func, "Remove background image");
299         RNA_def_function_flag(func, FUNC_USE_REPORTS);
300         parm = RNA_def_pointer(func, "image", "CameraBackgroundImage", "", "Image displayed as viewport background");
301         RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
302         RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
303
304         func = RNA_def_function(srna, "clear", "rna_Camera_background_images_clear");
305         RNA_def_function_ui_description(func, "Remove all background images");
306 }
307
308 static void rna_def_camera_stereo_data(BlenderRNA *brna)
309 {
310         StructRNA *srna;
311         PropertyRNA *prop;
312
313         static const EnumPropertyItem convergence_mode_items[] = {
314                 {CAM_S3D_OFFAXIS, "OFFAXIS", 0, "Off-Axis", "Off-axis frustums converging in a plane"},
315                 {CAM_S3D_PARALLEL, "PARALLEL", 0, "Parallel", "Parallel cameras with no convergence"},
316                 {CAM_S3D_TOE, "TOE", 0, "Toe-in", "Rotated cameras, looking at the convergence distance"},
317                 {0, NULL, 0, NULL, NULL}
318         };
319
320         static const EnumPropertyItem pivot_items[] = {
321                 {CAM_S3D_PIVOT_LEFT, "LEFT", 0, "Left", ""},
322                 {CAM_S3D_PIVOT_RIGHT, "RIGHT", 0, "Right", ""},
323                 {CAM_S3D_PIVOT_CENTER, "CENTER", 0, "Center", ""},
324                 {0, NULL, 0, NULL, NULL}
325         };
326
327         srna = RNA_def_struct(brna, "CameraStereoData", NULL);
328         RNA_def_struct_sdna(srna, "CameraStereoSettings");
329         RNA_def_struct_nested(brna, srna, "Camera");
330         RNA_def_struct_ui_text(srna, "Stereo", "Stereoscopy settings for a Camera data-block");
331
332         prop = RNA_def_property(srna, "convergence_mode", PROP_ENUM, PROP_NONE);
333         RNA_def_property_enum_items(prop, convergence_mode_items);
334         RNA_def_property_ui_text(prop, "Mode", "");
335         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
336
337         prop = RNA_def_property(srna, "pivot", PROP_ENUM, PROP_NONE);
338         RNA_def_property_enum_items(prop, pivot_items);
339         RNA_def_property_ui_text(prop, "Pivot", "");
340         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
341
342         prop = RNA_def_property(srna, "interocular_distance", PROP_FLOAT, PROP_DISTANCE);
343         RNA_def_property_range(prop, 0.0f, FLT_MAX);
344         RNA_def_property_ui_range(prop, 0.0f, 1e4f, 1, 3);
345         RNA_def_property_ui_text(prop, "Interocular Distance",
346                                  "Set the distance between the eyes - the stereo plane distance / 30 should be fine");
347         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
348
349         prop = RNA_def_property(srna, "convergence_distance", PROP_FLOAT, PROP_DISTANCE);
350         RNA_def_property_range(prop, 0.00001f, FLT_MAX);
351         RNA_def_property_ui_range(prop, 0.00001f, 15.f, 1, 3);
352         RNA_def_property_ui_text(prop, "Convergence Plane Distance",
353                                  "The converge point for the stereo cameras "
354                                  "(often the distance between a projector and the projection screen)");
355         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
356
357         prop = RNA_def_property(srna, "use_spherical_stereo", PROP_BOOLEAN, PROP_NONE);
358         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_S3D_SPHERICAL);
359         RNA_def_property_ui_text(prop, "Spherical Stereo",
360                                  "Render every pixel rotating the camera around the "
361                                  "middle of the interocular distance");
362         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
363
364         prop = RNA_def_property(srna, "use_pole_merge", PROP_BOOLEAN, PROP_NONE);
365         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_S3D_POLE_MERGE);
366         RNA_def_property_ui_text(prop, "Use Pole Merge",
367                                  "Fade interocular distance to 0 after the given cutoff angle");
368         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
369
370         prop = RNA_def_property(srna, "pole_merge_angle_from", PROP_FLOAT, PROP_ANGLE);
371         RNA_def_property_range(prop, 0.0f, M_PI / 2.0);
372         RNA_def_property_ui_text(prop, "Pole Merge Start Angle",
373                                  "Angle at which interocular distance starts to fade to 0");
374         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
375
376         prop = RNA_def_property(srna, "pole_merge_angle_to", PROP_FLOAT, PROP_ANGLE);
377         RNA_def_property_range(prop, 0.0f, M_PI / 2.0);
378         RNA_def_property_ui_text(prop, "Pole Merge End Angle",
379                                  "Angle at which interocular distance is 0");
380         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
381 }
382
383 void RNA_def_camera(BlenderRNA *brna)
384 {
385         StructRNA *srna;
386         PropertyRNA *prop;
387         static const EnumPropertyItem prop_type_items[] = {
388                 {CAM_PERSP, "PERSP", 0, "Perspective", ""},
389                 {CAM_ORTHO, "ORTHO", 0, "Orthographic", ""},
390                 {CAM_PANO, "PANO", 0, "Panoramic", ""},
391                 {0, NULL, 0, NULL, NULL}
392         };
393         static const EnumPropertyItem prop_display_type_extra_items[] = {
394                 {CAM_DTX_CENTER, "CENTER", 0, "Center", ""},
395                 {CAM_DTX_CENTER_DIAG, "CENTER_DIAGONAL", 0, "Center Diagonal", ""},
396                 {CAM_DTX_THIRDS, "THIRDS", 0, "Thirds", ""},
397                 {CAM_DTX_GOLDEN, "GOLDEN", 0, "Golden", ""},
398                 {CAM_DTX_GOLDEN_TRI_A, "GOLDEN_TRIANGLE_A", 0, "Golden Triangle A", ""},
399                 {CAM_DTX_GOLDEN_TRI_B, "GOLDEN_TRIANGLE_B", 0, "Golden Triangle B", ""},
400                 {CAM_DTX_HARMONY_TRI_A, "HARMONY_TRIANGLE_A", 0, "Harmonious Triangle A", ""},
401                 {CAM_DTX_HARMONY_TRI_B, "HARMONY_TRIANGLE_B", 0, "Harmonious Triangle B", ""},
402                 {0, NULL, 0, NULL, NULL}
403         };
404         static const EnumPropertyItem prop_lens_unit_items[] = {
405                 {0, "MILLIMETERS", 0, "Millimeters", "Specify the lens in millimeters"},
406                 {CAM_ANGLETOGGLE, "FOV", 0, "Field of View", "Specify the lens as the field of view's angle"},
407                 {0, NULL, 0, NULL, NULL}
408         };
409         static const EnumPropertyItem sensor_fit_items[] = {
410                 {CAMERA_SENSOR_FIT_AUTO, "AUTO", 0, "Auto", "Fit to the sensor width or height depending on image resolution"},
411                 {CAMERA_SENSOR_FIT_HOR, "HORIZONTAL", 0, "Horizontal", "Fit to the sensor width"},
412                 {CAMERA_SENSOR_FIT_VERT, "VERTICAL", 0, "Vertical", "Fit to the sensor height"},
413                 {0, NULL, 0, NULL, NULL}
414         };
415
416         srna = RNA_def_struct(brna, "Camera", "ID");
417         RNA_def_struct_ui_text(srna, "Camera", "Camera data-block for storing camera settings");
418         RNA_def_struct_ui_icon(srna, ICON_CAMERA_DATA);
419
420         /* Enums */
421         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
422         RNA_def_property_enum_items(prop, prop_type_items);
423         RNA_def_property_ui_text(prop, "Type", "Camera types");
424         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
425
426         prop = RNA_def_property(srna, "show_guide", PROP_ENUM, PROP_NONE);
427         RNA_def_property_enum_sdna(prop, NULL, "dtx");
428         RNA_def_property_enum_items(prop, prop_display_type_extra_items);
429         RNA_def_property_flag(prop, PROP_ENUM_FLAG);
430         RNA_def_property_ui_text(prop, "Composition Guides",  "Display overlay");
431         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
432
433         prop = RNA_def_property(srna, "sensor_fit", PROP_ENUM, PROP_NONE);
434         RNA_def_property_enum_sdna(prop, NULL, "sensor_fit");
435         RNA_def_property_enum_items(prop, sensor_fit_items);
436         RNA_def_property_ui_text(prop, "Sensor Fit", "Method to fit image and field of view angle inside the sensor");
437         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
438
439         /* Number values */
440
441         prop = RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_FACTOR);
442         RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
443         RNA_def_property_float_default(prop, 0.5f);
444         RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view");
445         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
446
447         prop = RNA_def_property(srna, "angle_x", PROP_FLOAT, PROP_ANGLE);
448         RNA_def_property_range(prop, DEG2RAD(0.367), DEG2RAD(172.847));
449         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
450         RNA_def_property_ui_text(prop, "Horizontal FOV", "Camera lens horizontal field of view");
451         RNA_def_property_float_funcs(prop, "rna_Camera_angle_x_get", "rna_Camera_angle_x_set", NULL);
452         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
453
454         prop = RNA_def_property(srna, "angle_y", PROP_FLOAT, PROP_ANGLE);
455         RNA_def_property_range(prop, DEG2RAD(0.367), DEG2RAD(172.847));
456         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
457         RNA_def_property_ui_text(prop, "Vertical FOV", "Camera lens vertical field of view");
458         RNA_def_property_float_funcs(prop, "rna_Camera_angle_y_get", "rna_Camera_angle_y_set", NULL);
459         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
460
461         prop = RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
462         RNA_def_property_range(prop, DEG2RAD(0.367), DEG2RAD(172.847));
463         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
464         RNA_def_property_ui_text(prop, "Field of View", "Camera lens field of view");
465         RNA_def_property_float_funcs(prop, "rna_Camera_angle_get", "rna_Camera_angle_set", NULL);
466         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
467
468         prop = RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
469         RNA_def_property_float_sdna(prop, NULL, "clipsta");
470         RNA_def_property_float_default(prop, 0.1f);
471         RNA_def_property_range(prop, 1e-6f, FLT_MAX);
472         RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
473         RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance");
474         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
475
476         prop = RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
477         RNA_def_property_float_sdna(prop, NULL, "clipend");
478         RNA_def_property_float_default(prop, 1000.0f);
479         RNA_def_property_range(prop, 1e-6f, FLT_MAX);
480         RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
481         RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance");
482         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
483
484         prop = RNA_def_property(srna, "lens", PROP_FLOAT, PROP_DISTANCE_CAMERA);
485         RNA_def_property_float_sdna(prop, NULL, "lens");
486         RNA_def_property_float_default(prop, 50.0f);
487         RNA_def_property_range(prop, 1.0f, FLT_MAX);
488         RNA_def_property_ui_range(prop, 1.0f, 5000.0f, 1, 2);
489         RNA_def_property_ui_text(prop, "Focal Length", "Perspective Camera lens value in millimeters");
490         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
491
492         prop = RNA_def_property(srna, "sensor_width", PROP_FLOAT, PROP_DISTANCE_CAMERA);
493         RNA_def_property_float_sdna(prop, NULL, "sensor_x");
494         RNA_def_property_float_default(prop, 36.0f);
495         RNA_def_property_range(prop, 1.0f, FLT_MAX);
496         RNA_def_property_ui_range(prop, 1.0f, 100.f, 1, 2);
497         RNA_def_property_ui_text(prop, "Sensor Width", "Horizontal size of the image sensor area in millimeters");
498         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
499
500         prop = RNA_def_property(srna, "sensor_height", PROP_FLOAT, PROP_DISTANCE_CAMERA);
501         RNA_def_property_float_sdna(prop, NULL, "sensor_y");
502         RNA_def_property_float_default(prop, 34.0f);
503         RNA_def_property_range(prop, 1.0f, FLT_MAX);
504         RNA_def_property_ui_range(prop, 1.0f, 100.f, 1, 2);
505         RNA_def_property_ui_text(prop, "Sensor Height", "Vertical size of the image sensor area in millimeters");
506         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
507
508         prop = RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
509         RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
510         RNA_def_property_float_default(prop, 6.0f);
511         RNA_def_property_range(prop, FLT_MIN, FLT_MAX);
512         RNA_def_property_ui_range(prop, 0.001f, 10000.0f, 10, 3);
513         RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom)");
514         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
515
516         prop = RNA_def_property(srna, "display_size", PROP_FLOAT, PROP_DISTANCE);
517 #if 0
518         RNA_def_property_float_sdna(prop, NULL, "drawsize");
519 #else
520         RNA_def_property_float_funcs(prop, "rna_Camera_draw_size_get", "rna_Camera_draw_size_set", NULL);
521 #endif
522         RNA_def_property_float_default(prop, 1.0f);
523         RNA_def_property_range(prop, 0.01f, 1000.0f);
524         RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
525         RNA_def_property_ui_text(prop, "Display Size", "Apparent size of the Camera object in the 3D View");
526         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
527
528         prop = RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
529         RNA_def_property_float_sdna(prop, NULL, "shiftx");
530         RNA_def_property_range(prop, -10.0f, 10.0f);
531         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
532         RNA_def_property_ui_text(prop, "Shift X", "Camera horizontal shift");
533         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
534
535         prop = RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
536         RNA_def_property_float_sdna(prop, NULL, "shifty");
537         RNA_def_property_range(prop, -10.0f, 10.0f);
538         RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
539         RNA_def_property_ui_text(prop, "Shift Y", "Camera vertical shift");
540         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
541
542         prop = RNA_def_property(srna, "dof_distance", PROP_FLOAT, PROP_DISTANCE);
543         RNA_def_property_float_sdna(prop, NULL, "YF_dofdist");
544         RNA_def_property_range(prop, 0.0f, FLT_MAX);
545         RNA_def_property_ui_range(prop, 0.0f, 5000.0f, 1, 2);
546         RNA_def_property_ui_text(prop, "DOF Distance", "Distance to the focus point for depth of field");
547         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dof_update");
548
549         /* Stereo Settings */
550         prop = RNA_def_property(srna, "stereo", PROP_POINTER, PROP_NONE);
551         RNA_def_property_flag(prop, PROP_NEVER_NULL);
552         RNA_def_property_pointer_sdna(prop, NULL, "stereo");
553         RNA_def_property_struct_type(prop, "CameraStereoData");
554         RNA_def_property_ui_text(prop, "Stereo", "");
555
556         /* flag */
557         prop = RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
558         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
559         RNA_def_property_ui_text(prop, "Show Limits", "Display the clipping range and focus point on the camera");
560         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
561
562         prop = RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
563         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
564         RNA_def_property_ui_text(prop, "Show Mist", "Display a line from the Camera to indicate the mist area");
565         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
566
567         prop = RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
568         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
569         RNA_def_property_boolean_default(prop, true);
570         RNA_def_property_ui_text(prop, "Show Passepartout",
571                                  "Show a darkened overlay outside the image area in Camera view");
572         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
573
574         prop = RNA_def_property(srna, "show_safe_areas", PROP_BOOLEAN, PROP_NONE);
575         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOW_SAFE_MARGINS);
576         RNA_def_property_ui_text(prop, "Show Safe Areas", "Show TV title safe and action safe areas in Camera view");
577         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
578
579         prop = RNA_def_property(srna, "show_safe_center", PROP_BOOLEAN, PROP_NONE);
580         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOW_SAFE_CENTER);
581         RNA_def_property_ui_text(prop, "Show Center-cut safe areas",
582                                  "Show safe areas to fit content in a different aspect ratio");
583         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
584
585         prop = RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
586         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
587         RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view");
588         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
589
590         prop = RNA_def_property(srna, "show_sensor", PROP_BOOLEAN, PROP_NONE);
591         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWSENSOR);
592         RNA_def_property_ui_text(prop, "Show Sensor Size", "Show sensor size (film gate) in Camera view");
593         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
594
595         prop = RNA_def_property(srna, "show_background_images", PROP_BOOLEAN, PROP_NONE);
596         RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOW_BG_IMAGE);
597         RNA_def_property_ui_text(prop, "Display Background Images",
598                                  "Display reference images behind objects in the 3D View");
599         RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
600
601         prop = RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
602         RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
603         RNA_def_property_enum_items(prop, prop_lens_unit_items);
604         RNA_def_property_ui_text(prop, "Lens Unit", "Unit to edit lens in for the user interface");
605
606         /* pointers */
607         prop = RNA_def_property(srna, "dof_object", PROP_POINTER, PROP_NONE);
608         RNA_def_property_struct_type(prop, "Object");
609         RNA_def_property_pointer_sdna(prop, NULL, "dof_ob");
610         RNA_def_property_flag(prop, PROP_EDITABLE);
611         RNA_def_property_ui_text(prop, "DOF Object", "Use this object to define the depth of field focal point");
612         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dependency_update");
613
614         prop = RNA_def_property(srna, "gpu_dof", PROP_POINTER, PROP_NONE);
615         RNA_def_property_struct_type(prop, "GPUDOFSettings");
616         RNA_def_property_ui_text(prop, "GPU Depth Of Field", "");
617         RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
618
619         prop = RNA_def_property(srna, "background_images", PROP_COLLECTION, PROP_NONE);
620         RNA_def_property_collection_sdna(prop, NULL, "bg_images", NULL);
621         RNA_def_property_struct_type(prop, "CameraBackgroundImage");
622         RNA_def_property_ui_text(prop, "Background Images", "List of background images");
623         RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
624
625         rna_def_animdata_common(srna);
626
627         rna_def_camera_background_image(brna);
628         rna_def_camera_background_images(brna, prop);
629
630         /* Nested Data  */
631         RNA_define_animate_sdna(true);
632
633         /* *** Animated *** */
634         rna_def_camera_stereo_data(brna);
635
636         /* Camera API */
637         RNA_api_camera(srna);
638 }
639
640 #endif