UI: File Browser Volumes and System Lists Icons
[blender.git] / source / blender / makesrna / intern / rna_camera.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16
17 /** \file
18  * \ingroup RNA
19  */
20
21 #include <stdlib.h>
22
23 #include "DNA_camera_types.h"
24
25 #include "BLI_math.h"
26
27 #include "RNA_access.h"
28 #include "RNA_define.h"
29
30 #include "rna_internal.h"
31
32 #include "WM_api.h"
33 #include "WM_types.h"
34
35 #ifdef RNA_RUNTIME
36
37 #  include "BKE_camera.h"
38 #  include "BKE_object.h"
39 #  include "BKE_sequencer.h"
40
41 #  include "DEG_depsgraph.h"
42 #  include "DEG_depsgraph_build.h"
43
44 static float rna_Camera_angle_get(PointerRNA *ptr)
45 {
46   Camera *cam = (Camera *)ptr->owner_id;
47   float sensor = BKE_camera_sensor_size(cam->sensor_fit, cam->sensor_x, cam->sensor_y);
48   return focallength_to_fov(cam->lens, sensor);
49 }
50
51 static void rna_Camera_angle_set(PointerRNA *ptr, float value)
52 {
53   Camera *cam = (Camera *)ptr->owner_id;
54   float sensor = BKE_camera_sensor_size(cam->sensor_fit, cam->sensor_x, cam->sensor_y);
55   cam->lens = fov_to_focallength(value, sensor);
56 }
57
58 static float rna_Camera_angle_x_get(PointerRNA *ptr)
59 {
60   Camera *cam = (Camera *)ptr->owner_id;
61   return focallength_to_fov(cam->lens, cam->sensor_x);
62 }
63
64 static void rna_Camera_angle_x_set(PointerRNA *ptr, float value)
65 {
66   Camera *cam = (Camera *)ptr->owner_id;
67   cam->lens = fov_to_focallength(value, cam->sensor_x);
68 }
69
70 static float rna_Camera_angle_y_get(PointerRNA *ptr)
71 {
72   Camera *cam = (Camera *)ptr->owner_id;
73   return focallength_to_fov(cam->lens, cam->sensor_y);
74 }
75
76 static void rna_Camera_angle_y_set(PointerRNA *ptr, float value)
77 {
78   Camera *cam = (Camera *)ptr->owner_id;
79   cam->lens = fov_to_focallength(value, cam->sensor_y);
80 }
81
82 static void rna_Camera_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
83 {
84   Camera *camera = (Camera *)ptr->owner_id;
85
86   DEG_id_tag_update(&camera->id, 0);
87 }
88
89 static void rna_Camera_dependency_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
90 {
91   Camera *camera = (Camera *)ptr->owner_id;
92   DEG_relations_tag_update(bmain);
93   DEG_id_tag_update(&camera->id, 0);
94 }
95
96 static CameraBGImage *rna_Camera_background_images_new(Camera *cam)
97 {
98   CameraBGImage *bgpic = BKE_camera_background_image_new(cam);
99
100   WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
101
102   return bgpic;
103 }
104
105 static void rna_Camera_background_images_remove(Camera *cam,
106                                                 ReportList *reports,
107                                                 PointerRNA *bgpic_ptr)
108 {
109   CameraBGImage *bgpic = bgpic_ptr->data;
110   if (BLI_findindex(&cam->bg_images, bgpic) == -1) {
111     BKE_report(reports, RPT_ERROR, "Background image cannot be removed");
112   }
113
114   BKE_camera_background_image_remove(cam, bgpic);
115   RNA_POINTER_INVALIDATE(bgpic_ptr);
116
117   WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
118 }
119
120 static void rna_Camera_background_images_clear(Camera *cam)
121 {
122   BKE_camera_background_image_clear(cam);
123
124   WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
125 }
126
127 static void rna_Camera_dof_update(Main *bmain, Scene *scene, PointerRNA *UNUSED(ptr))
128 {
129   BKE_sequence_invalidate_scene_strips(bmain, scene);
130   WM_main_add_notifier(NC_SCENE | ND_SEQUENCER, scene);
131 }
132
133 char *rna_CameraDOFSettings_path(PointerRNA *ptr)
134 {
135   /* if there is ID-data, resolve the path using the index instead of by name,
136    * since the name used is the name of the texture assigned, but the texture
137    * may be used multiple times in the same stack
138    */
139   if (ptr->owner_id) {
140     if (GS(ptr->owner_id->name) == ID_CA) {
141       return BLI_strdup("dof");
142     }
143   }
144
145   return BLI_strdup("");
146 }
147
148 static void rna_CameraDOFSettings_aperture_blades_set(PointerRNA *ptr, const int value)
149 {
150   CameraDOFSettings *dofsettings = (CameraDOFSettings *)ptr->data;
151
152   if (value == 1 || value == 2) {
153     if (dofsettings->aperture_blades == 0) {
154       dofsettings->aperture_blades = 3;
155     }
156     else {
157       dofsettings->aperture_blades = 0;
158     }
159   }
160   else {
161     dofsettings->aperture_blades = value;
162   }
163 }
164
165 #else
166
167 static void rna_def_camera_background_image(BlenderRNA *brna)
168 {
169   StructRNA *srna;
170   PropertyRNA *prop;
171
172   static const EnumPropertyItem bgpic_source_items[] = {
173       {CAM_BGIMG_SOURCE_IMAGE, "IMAGE", 0, "Image", ""},
174       {CAM_BGIMG_SOURCE_MOVIE, "MOVIE_CLIP", 0, "Movie Clip", ""},
175       {0, NULL, 0, NULL, NULL},
176   };
177
178   static const EnumPropertyItem bgpic_camera_frame_items[] = {
179       {0, "STRETCH", 0, "Stretch", ""},
180       {CAM_BGIMG_FLAG_CAMERA_ASPECT, "FIT", 0, "Fit", ""},
181       {CAM_BGIMG_FLAG_CAMERA_ASPECT | CAM_BGIMG_FLAG_CAMERA_CROP, "CROP", 0, "Crop", ""},
182       {0, NULL, 0, NULL, NULL},
183   };
184
185   static const EnumPropertyItem bgpic_display_depth_items[] = {
186       {0, "BACK", 0, "Back", ""},
187       {CAM_BGIMG_FLAG_FOREGROUND, "FRONT", 0, "Front", ""},
188       {0, NULL, 0, NULL, NULL},
189   };
190
191   srna = RNA_def_struct(brna, "CameraBackgroundImage", NULL);
192   RNA_def_struct_sdna(srna, "CameraBGImage");
193   RNA_def_struct_ui_text(
194       srna, "Background Image", "Image and settings for display in the 3D View background");
195
196   prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
197   RNA_def_property_enum_sdna(prop, NULL, "source");
198   RNA_def_property_enum_items(prop, bgpic_source_items);
199   RNA_def_property_ui_text(prop, "Background Source", "Data source used for background");
200   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
201
202   prop = RNA_def_property(srna, "image", PROP_POINTER, PROP_NONE);
203   RNA_def_property_pointer_sdna(prop, NULL, "ima");
204   RNA_def_property_ui_text(prop, "Image", "Image displayed and edited in this space");
205   RNA_def_property_flag(prop, PROP_EDITABLE);
206   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
207   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
208
209   prop = RNA_def_property(srna, "clip", PROP_POINTER, PROP_NONE);
210   RNA_def_property_pointer_sdna(prop, NULL, "clip");
211   RNA_def_property_ui_text(prop, "MovieClip", "Movie clip displayed and edited in this space");
212   RNA_def_property_flag(prop, PROP_EDITABLE);
213   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
214   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
215
216   prop = RNA_def_property(srna, "image_user", PROP_POINTER, PROP_NONE);
217   RNA_def_property_flag(prop, PROP_NEVER_NULL);
218   RNA_def_property_pointer_sdna(prop, NULL, "iuser");
219   RNA_def_property_ui_text(
220       prop,
221       "Image User",
222       "Parameters defining which layer, pass and frame of the image is displayed");
223   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
224
225   prop = RNA_def_property(srna, "clip_user", PROP_POINTER, PROP_NONE);
226   RNA_def_property_flag(prop, PROP_NEVER_NULL);
227   RNA_def_property_struct_type(prop, "MovieClipUser");
228   RNA_def_property_pointer_sdna(prop, NULL, "cuser");
229   RNA_def_property_ui_text(
230       prop, "Clip User", "Parameters defining which frame of the movie clip is displayed");
231   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
232
233   prop = RNA_def_property(srna, "offset", PROP_FLOAT, PROP_XYZ);
234   RNA_def_property_float_sdna(prop, NULL, "offset");
235   RNA_def_property_ui_text(prop, "Offset", "");
236   RNA_def_property_ui_range(prop, -FLT_MAX, FLT_MAX, 0.1, RNA_TRANSLATION_PREC_DEFAULT);
237   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
238
239   prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_NONE);
240   RNA_def_property_float_sdna(prop, NULL, "scale");
241   RNA_def_property_ui_text(prop, "Scale", "Scale the background image");
242   RNA_def_property_range(prop, 0.0, FLT_MAX);
243   RNA_def_property_ui_range(prop, 0.0, 10.0, 0.100, RNA_TRANSLATION_PREC_DEFAULT);
244   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
245
246   prop = RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ANGLE);
247   RNA_def_property_float_sdna(prop, NULL, "rotation");
248   RNA_def_property_ui_text(
249       prop, "Rotation", "Rotation for the background image (ortho view only)");
250   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
251
252   prop = RNA_def_property(srna, "use_flip_x", PROP_BOOLEAN, PROP_NONE);
253   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FLIP_X);
254   RNA_def_property_ui_text(prop, "Flip Horizontally", "Flip the background image horizontally");
255   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
256
257   prop = RNA_def_property(srna, "use_flip_y", PROP_BOOLEAN, PROP_NONE);
258   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FLIP_Y);
259   RNA_def_property_ui_text(prop, "Flip Vertically", "Flip the background image vertically");
260   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
261
262   prop = RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
263   RNA_def_property_float_sdna(prop, NULL, "alpha");
264   RNA_def_property_ui_text(
265       prop, "Alpha", "Image opacity to blend the image against the background color");
266   RNA_def_property_range(prop, 0.0, 1.0);
267   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
268
269   prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
270   RNA_def_property_flag(prop, PROP_NO_DEG_UPDATE);
271   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_EXPANDED);
272   RNA_def_property_ui_text(prop, "Show Expanded", "Show the expanded in the user interface");
273   RNA_def_property_ui_icon(prop, ICON_DISCLOSURE_TRI_RIGHT, 1);
274
275   prop = RNA_def_property(srna, "use_camera_clip", PROP_BOOLEAN, PROP_NONE);
276   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_CAMERACLIP);
277   RNA_def_property_ui_text(prop, "Camera Clip", "Use movie clip from active scene camera");
278   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
279
280   prop = RNA_def_property(srna, "show_background_image", PROP_BOOLEAN, PROP_NONE);
281   RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_DISABLED);
282   RNA_def_property_ui_text(prop, "Show Background Image", "Show this image as background");
283   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
284
285   prop = RNA_def_property(srna, "show_on_foreground", PROP_BOOLEAN, PROP_NONE);
286   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FOREGROUND);
287   RNA_def_property_ui_text(
288       prop, "Show On Foreground", "Show this image in front of objects in viewport");
289   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
290
291   /* expose 1 flag as a enum of 2 items */
292   prop = RNA_def_property(srna, "display_depth", PROP_ENUM, PROP_NONE);
293   RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
294   RNA_def_property_enum_items(prop, bgpic_display_depth_items);
295   RNA_def_property_ui_text(prop, "Depth", "Display under or over everything");
296   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
297
298   /* expose 2 flags as a enum of 3 items */
299   prop = RNA_def_property(srna, "frame_method", PROP_ENUM, PROP_NONE);
300   RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
301   RNA_def_property_enum_items(prop, bgpic_camera_frame_items);
302   RNA_def_property_ui_text(prop, "Frame Method", "How the image fits in the camera frame");
303   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
304 }
305
306 static void rna_def_camera_background_images(BlenderRNA *brna, PropertyRNA *cprop)
307 {
308   StructRNA *srna;
309   FunctionRNA *func;
310   PropertyRNA *parm;
311
312   RNA_def_property_srna(cprop, "CameraBackgroundImages");
313   srna = RNA_def_struct(brna, "CameraBackgroundImages", NULL);
314   RNA_def_struct_sdna(srna, "Camera");
315   RNA_def_struct_ui_text(srna, "Background Images", "Collection of background images");
316
317   func = RNA_def_function(srna, "new", "rna_Camera_background_images_new");
318   RNA_def_function_ui_description(func, "Add new background image");
319   parm = RNA_def_pointer(
320       func, "image", "CameraBackgroundImage", "", "Image displayed as viewport background");
321   RNA_def_function_return(func, parm);
322
323   func = RNA_def_function(srna, "remove", "rna_Camera_background_images_remove");
324   RNA_def_function_ui_description(func, "Remove background image");
325   RNA_def_function_flag(func, FUNC_USE_REPORTS);
326   parm = RNA_def_pointer(
327       func, "image", "CameraBackgroundImage", "", "Image displayed as viewport background");
328   RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
329   RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
330
331   func = RNA_def_function(srna, "clear", "rna_Camera_background_images_clear");
332   RNA_def_function_ui_description(func, "Remove all background images");
333 }
334
335 static void rna_def_camera_stereo_data(BlenderRNA *brna)
336 {
337   StructRNA *srna;
338   PropertyRNA *prop;
339
340   static const EnumPropertyItem convergence_mode_items[] = {
341       {CAM_S3D_OFFAXIS, "OFFAXIS", 0, "Off-Axis", "Off-axis frustums converging in a plane"},
342       {CAM_S3D_PARALLEL, "PARALLEL", 0, "Parallel", "Parallel cameras with no convergence"},
343       {CAM_S3D_TOE, "TOE", 0, "Toe-in", "Rotated cameras, looking at the convergence distance"},
344       {0, NULL, 0, NULL, NULL},
345   };
346
347   static const EnumPropertyItem pivot_items[] = {
348       {CAM_S3D_PIVOT_LEFT, "LEFT", 0, "Left", ""},
349       {CAM_S3D_PIVOT_RIGHT, "RIGHT", 0, "Right", ""},
350       {CAM_S3D_PIVOT_CENTER, "CENTER", 0, "Center", ""},
351       {0, NULL, 0, NULL, NULL},
352   };
353
354   srna = RNA_def_struct(brna, "CameraStereoData", NULL);
355   RNA_def_struct_sdna(srna, "CameraStereoSettings");
356   RNA_def_struct_nested(brna, srna, "Camera");
357   RNA_def_struct_ui_text(srna, "Stereo", "Stereoscopy settings for a Camera data-block");
358
359   prop = RNA_def_property(srna, "convergence_mode", PROP_ENUM, PROP_NONE);
360   RNA_def_property_enum_items(prop, convergence_mode_items);
361   RNA_def_property_ui_text(prop, "Mode", "");
362   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
363
364   prop = RNA_def_property(srna, "pivot", PROP_ENUM, PROP_NONE);
365   RNA_def_property_enum_items(prop, pivot_items);
366   RNA_def_property_ui_text(prop, "Pivot", "");
367   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
368
369   prop = RNA_def_property(srna, "interocular_distance", PROP_FLOAT, PROP_DISTANCE);
370   RNA_def_property_range(prop, 0.0f, FLT_MAX);
371   RNA_def_property_ui_range(prop, 0.0f, 1e4f, 1, 3);
372   RNA_def_property_ui_text(
373       prop,
374       "Interocular Distance",
375       "Set the distance between the eyes - the stereo plane distance / 30 should be fine");
376   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
377
378   prop = RNA_def_property(srna, "convergence_distance", PROP_FLOAT, PROP_DISTANCE);
379   RNA_def_property_range(prop, 0.00001f, FLT_MAX);
380   RNA_def_property_ui_range(prop, 0.00001f, 15.f, 1, 3);
381   RNA_def_property_ui_text(prop,
382                            "Convergence Plane Distance",
383                            "The converge point for the stereo cameras "
384                            "(often the distance between a projector and the projection screen)");
385   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
386
387   prop = RNA_def_property(srna, "use_spherical_stereo", PROP_BOOLEAN, PROP_NONE);
388   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_S3D_SPHERICAL);
389   RNA_def_property_ui_text(prop,
390                            "Spherical Stereo",
391                            "Render every pixel rotating the camera around the "
392                            "middle of the interocular distance");
393   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
394
395   prop = RNA_def_property(srna, "use_pole_merge", PROP_BOOLEAN, PROP_NONE);
396   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_S3D_POLE_MERGE);
397   RNA_def_property_ui_text(
398       prop, "Use Pole Merge", "Fade interocular distance to 0 after the given cutoff angle");
399   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
400
401   prop = RNA_def_property(srna, "pole_merge_angle_from", PROP_FLOAT, PROP_ANGLE);
402   RNA_def_property_range(prop, 0.0f, M_PI / 2.0);
403   RNA_def_property_ui_text(
404       prop, "Pole Merge Start Angle", "Angle at which interocular distance starts to fade to 0");
405   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
406
407   prop = RNA_def_property(srna, "pole_merge_angle_to", PROP_FLOAT, PROP_ANGLE);
408   RNA_def_property_range(prop, 0.0f, M_PI / 2.0);
409   RNA_def_property_ui_text(
410       prop, "Pole Merge End Angle", "Angle at which interocular distance is 0");
411   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
412 }
413
414 static void rna_def_camera_dof_settings_data(BlenderRNA *brna)
415 {
416   StructRNA *srna;
417   PropertyRNA *prop;
418
419   srna = RNA_def_struct(brna, "CameraDOFSettings", NULL);
420   RNA_def_struct_sdna(srna, "CameraDOFSettings");
421   RNA_def_struct_path_func(srna, "rna_CameraDOFSettings_path");
422   RNA_def_struct_ui_text(srna, "Depth of Field", "Depth of Field settings");
423
424   prop = RNA_def_property(srna, "use_dof", PROP_BOOLEAN, PROP_NONE);
425   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_DOF_ENABLED);
426   RNA_def_property_ui_text(prop, "Depth of Field", "Use Depth of Field");
427   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dof_update");
428
429   prop = RNA_def_property(srna, "focus_object", PROP_POINTER, PROP_NONE);
430   RNA_def_property_struct_type(prop, "Object");
431   RNA_def_property_pointer_sdna(prop, NULL, "focus_object");
432   RNA_def_property_flag(prop, PROP_EDITABLE);
433   RNA_def_property_override_flag(prop, PROPOVERRIDE_OVERRIDABLE_LIBRARY);
434   RNA_def_property_ui_text(
435       prop, "Focus Object", "Use this object to define the depth of field focal point");
436   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dependency_update");
437
438   prop = RNA_def_property(srna, "focus_distance", PROP_FLOAT, PROP_DISTANCE);
439   // RNA_def_property_pointer_sdna(prop, NULL, "focus_distance");
440   RNA_def_property_range(prop, 0.0f, FLT_MAX);
441   RNA_def_property_ui_range(prop, 0.0f, 5000.0f, 1, 2);
442   RNA_def_property_ui_text(
443       prop, "Focus Distance", "Distance to the focus point for depth of field");
444   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dof_update");
445
446   prop = RNA_def_property(srna, "aperture_fstop", PROP_FLOAT, PROP_NONE);
447   RNA_def_property_ui_text(
448       prop,
449       "F-Stop",
450       "F-Stop ratio (lower numbers give more defocus, higher numbers give a sharper image)");
451   RNA_def_property_range(prop, 0.0f, FLT_MAX);
452   RNA_def_property_ui_range(prop, 0.1f, 128.0f, 10, 1);
453   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dof_update");
454
455   prop = RNA_def_property(srna, "aperture_blades", PROP_INT, PROP_NONE);
456   RNA_def_property_ui_text(
457       prop, "Blades", "Number of blades in aperture for polygonal bokeh (at least 3)");
458   RNA_def_property_range(prop, 0, 16);
459   RNA_def_property_int_funcs(prop, NULL, "rna_CameraDOFSettings_aperture_blades_set", NULL);
460   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dof_update");
461
462   prop = RNA_def_property(srna, "aperture_rotation", PROP_FLOAT, PROP_ANGLE);
463   RNA_def_property_ui_text(prop, "Rotation", "Rotation of blades in aperture");
464   RNA_def_property_range(prop, -M_PI, M_PI);
465   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dof_update");
466
467   prop = RNA_def_property(srna, "aperture_ratio", PROP_FLOAT, PROP_NONE);
468   RNA_def_property_ui_text(prop, "Ratio", "Distortion to simulate anamorphic lens bokeh");
469   RNA_def_property_range(prop, 0.01f, FLT_MAX);
470   RNA_def_property_ui_range(prop, 1.0f, 2.0f, 0.1, 3);
471   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_dof_update");
472 }
473
474 void RNA_def_camera(BlenderRNA *brna)
475 {
476   StructRNA *srna;
477   PropertyRNA *prop;
478   static const EnumPropertyItem prop_type_items[] = {
479       {CAM_PERSP, "PERSP", 0, "Perspective", ""},
480       {CAM_ORTHO, "ORTHO", 0, "Orthographic", ""},
481       {CAM_PANO, "PANO", 0, "Panoramic", ""},
482       {0, NULL, 0, NULL, NULL},
483   };
484   static const EnumPropertyItem prop_lens_unit_items[] = {
485       {0, "MILLIMETERS", 0, "Millimeters", "Specify the lens in millimeters"},
486       {CAM_ANGLETOGGLE,
487        "FOV",
488        0,
489        "Field of View",
490        "Specify the lens as the field of view's angle"},
491       {0, NULL, 0, NULL, NULL},
492   };
493   static const EnumPropertyItem sensor_fit_items[] = {
494       {CAMERA_SENSOR_FIT_AUTO,
495        "AUTO",
496        0,
497        "Auto",
498        "Fit to the sensor width or height depending on image resolution"},
499       {CAMERA_SENSOR_FIT_HOR, "HORIZONTAL", 0, "Horizontal", "Fit to the sensor width"},
500       {CAMERA_SENSOR_FIT_VERT, "VERTICAL", 0, "Vertical", "Fit to the sensor height"},
501       {0, NULL, 0, NULL, NULL},
502   };
503
504   srna = RNA_def_struct(brna, "Camera", "ID");
505   RNA_def_struct_ui_text(srna, "Camera", "Camera data-block for storing camera settings");
506   RNA_def_struct_ui_icon(srna, ICON_CAMERA_DATA);
507
508   /* Enums */
509   prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
510   RNA_def_property_enum_items(prop, prop_type_items);
511   RNA_def_property_ui_text(prop, "Type", "Camera types");
512   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
513
514   prop = RNA_def_property(srna, "sensor_fit", PROP_ENUM, PROP_NONE);
515   RNA_def_property_enum_sdna(prop, NULL, "sensor_fit");
516   RNA_def_property_enum_items(prop, sensor_fit_items);
517   RNA_def_property_ui_text(
518       prop, "Sensor Fit", "Method to fit image and field of view angle inside the sensor");
519   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
520
521   /* Number values */
522
523   prop = RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_FACTOR);
524   RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
525   RNA_def_property_ui_text(
526       prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view");
527   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
528
529   prop = RNA_def_property(srna, "angle_x", PROP_FLOAT, PROP_ANGLE);
530   RNA_def_property_range(prop, DEG2RAD(0.367), DEG2RAD(172.847));
531   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
532   RNA_def_property_ui_text(prop, "Horizontal FOV", "Camera lens horizontal field of view");
533   RNA_def_property_float_funcs(prop, "rna_Camera_angle_x_get", "rna_Camera_angle_x_set", NULL);
534   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
535
536   prop = RNA_def_property(srna, "angle_y", PROP_FLOAT, PROP_ANGLE);
537   RNA_def_property_range(prop, DEG2RAD(0.367), DEG2RAD(172.847));
538   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
539   RNA_def_property_ui_text(prop, "Vertical FOV", "Camera lens vertical field of view");
540   RNA_def_property_float_funcs(prop, "rna_Camera_angle_y_get", "rna_Camera_angle_y_set", NULL);
541   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
542
543   prop = RNA_def_property(srna, "angle", PROP_FLOAT, PROP_ANGLE);
544   RNA_def_property_range(prop, DEG2RAD(0.367), DEG2RAD(172.847));
545   RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
546   RNA_def_property_ui_text(prop, "Field of View", "Camera lens field of view");
547   RNA_def_property_float_funcs(prop, "rna_Camera_angle_get", "rna_Camera_angle_set", NULL);
548   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
549
550   prop = RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
551   RNA_def_property_range(prop, 1e-6f, FLT_MAX);
552   RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
553   RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance");
554   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
555
556   prop = RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
557   RNA_def_property_range(prop, 1e-6f, FLT_MAX);
558   RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
559   RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance");
560   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
561
562   prop = RNA_def_property(srna, "lens", PROP_FLOAT, PROP_DISTANCE_CAMERA);
563   RNA_def_property_float_sdna(prop, NULL, "lens");
564   RNA_def_property_range(prop, 1.0f, FLT_MAX);
565   RNA_def_property_ui_range(prop, 1.0f, 5000.0f, 100, 4);
566   RNA_def_property_ui_text(prop, "Focal Length", "Perspective Camera lens value in millimeters");
567   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
568
569   prop = RNA_def_property(srna, "sensor_width", PROP_FLOAT, PROP_DISTANCE_CAMERA);
570   RNA_def_property_float_sdna(prop, NULL, "sensor_x");
571   RNA_def_property_range(prop, 1.0f, FLT_MAX);
572   RNA_def_property_ui_range(prop, 1.0f, 100.f, 100, 4);
573   RNA_def_property_ui_text(
574       prop, "Sensor Width", "Horizontal size of the image sensor area in millimeters");
575   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
576
577   prop = RNA_def_property(srna, "sensor_height", PROP_FLOAT, PROP_DISTANCE_CAMERA);
578   RNA_def_property_float_sdna(prop, NULL, "sensor_y");
579   RNA_def_property_range(prop, 1.0f, FLT_MAX);
580   RNA_def_property_ui_range(prop, 1.0f, 100.f, 100, 4);
581   RNA_def_property_ui_text(
582       prop, "Sensor Height", "Vertical size of the image sensor area in millimeters");
583   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
584
585   prop = RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
586   RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
587   RNA_def_property_range(prop, FLT_MIN, FLT_MAX);
588   RNA_def_property_ui_range(prop, 0.001f, 10000.0f, 10, 3);
589   RNA_def_property_ui_text(
590       prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom)");
591   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
592
593   prop = RNA_def_property(srna, "display_size", PROP_FLOAT, PROP_DISTANCE);
594   RNA_def_property_float_sdna(prop, NULL, "drawsize");
595   RNA_def_property_range(prop, 0.01f, 1000.0f);
596   RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
597   RNA_def_property_ui_text(
598       prop, "Display Size", "Apparent size of the Camera object in the 3D View");
599   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
600
601   prop = RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
602   RNA_def_property_float_sdna(prop, NULL, "shiftx");
603   RNA_def_property_range(prop, -10.0f, 10.0f);
604   RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
605   RNA_def_property_ui_text(prop, "Shift X", "Camera horizontal shift");
606   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
607
608   prop = RNA_def_property(srna, "shift_y", PROP_FLOAT, PROP_NONE);
609   RNA_def_property_float_sdna(prop, NULL, "shifty");
610   RNA_def_property_range(prop, -10.0f, 10.0f);
611   RNA_def_property_ui_range(prop, -2.0, 2.0, 1, 3);
612   RNA_def_property_ui_text(prop, "Shift Y", "Camera vertical shift");
613   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
614
615   /* Stereo Settings */
616   prop = RNA_def_property(srna, "stereo", PROP_POINTER, PROP_NONE);
617   RNA_def_property_flag(prop, PROP_NEVER_NULL);
618   RNA_def_property_pointer_sdna(prop, NULL, "stereo");
619   RNA_def_property_struct_type(prop, "CameraStereoData");
620   RNA_def_property_ui_text(prop, "Stereo", "");
621
622   /* flag */
623   prop = RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
624   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
625   RNA_def_property_ui_text(
626       prop, "Show Limits", "Display the clipping range and focus point on the camera");
627   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
628
629   prop = RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
630   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
631   RNA_def_property_ui_text(
632       prop, "Show Mist", "Display a line from the Camera to indicate the mist area");
633   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
634
635   prop = RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
636   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
637   RNA_def_property_ui_text(
638       prop, "Show Passepartout", "Show a darkened overlay outside the image area in Camera view");
639   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
640
641   prop = RNA_def_property(srna, "show_safe_areas", PROP_BOOLEAN, PROP_NONE);
642   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOW_SAFE_MARGINS);
643   RNA_def_property_ui_text(
644       prop, "Show Safe Areas", "Show TV title safe and action safe areas in Camera view");
645   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
646
647   prop = RNA_def_property(srna, "show_safe_center", PROP_BOOLEAN, PROP_NONE);
648   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOW_SAFE_CENTER);
649   RNA_def_property_ui_text(prop,
650                            "Show Center-cut safe areas",
651                            "Show safe areas to fit content in a different aspect ratio");
652   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
653
654   prop = RNA_def_property(srna, "show_name", PROP_BOOLEAN, PROP_NONE);
655   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWNAME);
656   RNA_def_property_ui_text(prop, "Show Name", "Show the active Camera's name in Camera view");
657   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
658
659   prop = RNA_def_property(srna, "show_sensor", PROP_BOOLEAN, PROP_NONE);
660   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWSENSOR);
661   RNA_def_property_ui_text(
662       prop, "Show Sensor Size", "Show sensor size (film gate) in Camera view");
663   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
664
665   prop = RNA_def_property(srna, "show_background_images", PROP_BOOLEAN, PROP_NONE);
666   RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOW_BG_IMAGE);
667   RNA_def_property_ui_text(
668       prop, "Display Background Images", "Display reference images behind objects in the 3D View");
669   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
670
671   prop = RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
672   RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
673   RNA_def_property_enum_items(prop, prop_lens_unit_items);
674   RNA_def_property_ui_text(prop, "Lens Unit", "Unit to edit lens in for the user interface");
675
676   /* dtx */
677   prop = RNA_def_property(srna, "show_composition_center", PROP_BOOLEAN, PROP_NONE);
678   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_CENTER);
679   RNA_def_property_ui_text(
680       prop, "Center", "Display center composition guide inside the camera view");
681   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
682
683   prop = RNA_def_property(srna, "show_composition_center_diagonal", PROP_BOOLEAN, PROP_NONE);
684   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_CENTER_DIAG);
685   RNA_def_property_ui_text(
686       prop, "Center Diagonal", "Display diagonal center composition guide inside the camera view");
687   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
688
689   prop = RNA_def_property(srna, "show_composition_thirds", PROP_BOOLEAN, PROP_NONE);
690   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_THIRDS);
691   RNA_def_property_ui_text(
692       prop, "Thirds", "Display rule of thirds composition guide inside the camera view");
693   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
694
695   prop = RNA_def_property(srna, "show_composition_golden", PROP_BOOLEAN, PROP_NONE);
696   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_GOLDEN);
697   RNA_def_property_ui_text(
698       prop, "Golden Ratio", "Display golden ratio composition guide inside the camera view");
699   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
700
701   prop = RNA_def_property(srna, "show_composition_golden_tria_a", PROP_BOOLEAN, PROP_NONE);
702   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_GOLDEN_TRI_A);
703   RNA_def_property_ui_text(prop,
704                            "Golden Triangle A",
705                            "Display golden triangle A composition guide inside the camera view");
706   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
707
708   prop = RNA_def_property(srna, "show_composition_golden_tria_b", PROP_BOOLEAN, PROP_NONE);
709   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_GOLDEN_TRI_B);
710   RNA_def_property_ui_text(prop,
711                            "Golden Triangle B",
712                            "Display golden triangle B composition guide inside the camera view");
713   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
714
715   prop = RNA_def_property(srna, "show_composition_harmony_tri_a", PROP_BOOLEAN, PROP_NONE);
716   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_HARMONY_TRI_A);
717   RNA_def_property_ui_text(
718       prop, "Harmonious Triangle A", "Display harmony A composition guide inside the camera view");
719   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
720
721   prop = RNA_def_property(srna, "show_composition_harmony_tri_b", PROP_BOOLEAN, PROP_NONE);
722   RNA_def_property_boolean_sdna(prop, NULL, "dtx", CAM_DTX_HARMONY_TRI_B);
723   RNA_def_property_ui_text(
724       prop, "Harmonious Triangle B", "Display harmony B composition guide inside the camera view");
725   RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
726
727   /* pointers */
728   prop = RNA_def_property(srna, "dof", PROP_POINTER, PROP_NONE);
729   RNA_def_property_struct_type(prop, "CameraDOFSettings");
730   RNA_def_property_ui_text(prop, "Depth Of Field", "");
731   RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
732
733   prop = RNA_def_property(srna, "background_images", PROP_COLLECTION, PROP_NONE);
734   RNA_def_property_collection_sdna(prop, NULL, "bg_images", NULL);
735   RNA_def_property_struct_type(prop, "CameraBackgroundImage");
736   RNA_def_property_ui_text(prop, "Background Images", "List of background images");
737   RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
738
739   rna_def_animdata_common(srna);
740
741   rna_def_camera_background_image(brna);
742   rna_def_camera_background_images(brna, prop);
743
744   /* Nested Data  */
745   RNA_define_animate_sdna(true);
746
747   /* *** Animated *** */
748   rna_def_camera_stereo_data(brna);
749   rna_def_camera_dof_settings_data(brna);
750
751   /* Camera API */
752   RNA_api_camera(srna);
753 }
754
755 #endif