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