Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_camera.c
index c1a76b1627a408bdfafdb55d9b2ca87cc887a717..aee14cd3185d4cce3a5f769750f62aa92e7d5181 100644 (file)
 
 #include "BLI_math.h"
 
+#include "RNA_access.h"
 #include "RNA_define.h"
 
 #include "rna_internal.h"
 
+#include "WM_api.h"
 #include "WM_types.h"
 
 #ifdef RNA_RUNTIME
 
 #include "BKE_camera.h"
-#include "BKE_depsgraph.h"
 #include "BKE_object.h"
 #include "BKE_sequencer.h"
 
-#include "WM_api.h"
+#include "DEG_depsgraph.h"
+#include "DEG_depsgraph_build.h"
 
 static float rna_Camera_draw_size_get(PointerRNA *ptr)
 {
@@ -99,14 +101,43 @@ static void rna_Camera_update(Main *UNUSED(bmain), Scene *UNUSED(scene), Pointer
 {
        Camera *camera = (Camera *)ptr->id.data;
 
-       DAG_id_tag_update(&camera->id, 0);
+       DEG_id_tag_update(&camera->id, 0);
 }
 
 static void rna_Camera_dependency_update(Main *bmain, Scene *UNUSED(scene), PointerRNA *ptr)
 {
        Camera *camera = (Camera *)ptr->id.data;
-       DAG_relations_tag_update(bmain);
-       DAG_id_tag_update(&camera->id, 0);
+       DEG_relations_tag_update(bmain);
+       DEG_id_tag_update(&camera->id, 0);
+}
+
+static CameraBGImage *rna_Camera_background_images_new(Camera *cam)
+{
+       CameraBGImage *bgpic = BKE_camera_background_image_new(cam);
+
+       WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
+
+       return bgpic;
+}
+
+static void rna_Camera_background_images_remove(Camera *cam, ReportList *reports, PointerRNA *bgpic_ptr)
+{
+       CameraBGImage *bgpic = bgpic_ptr->data;
+       if (BLI_findindex(&cam->bg_images, bgpic) == -1) {
+               BKE_report(reports, RPT_ERROR, "Background image cannot be removed");
+       }
+
+       BKE_camera_background_image_remove(cam, bgpic);
+       RNA_POINTER_INVALIDATE(bgpic_ptr);
+
+       WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
+}
+
+static void rna_Camera_background_images_clear(Camera *cam)
+{
+       BKE_camera_background_image_clear(cam);
+
+       WM_main_add_notifier(NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, cam);
 }
 
 static void rna_Camera_dof_update(Main *UNUSED(bmain), Scene *scene, PointerRNA *UNUSED(ptr))
@@ -119,6 +150,161 @@ static void rna_Camera_dof_update(Main *UNUSED(bmain), Scene *scene, PointerRNA
 
 #else
 
+static void rna_def_camera_background_image(BlenderRNA *brna)
+{
+       StructRNA *srna;
+       PropertyRNA *prop;
+
+       static const EnumPropertyItem bgpic_source_items[] = {
+               {CAM_BGIMG_SOURCE_IMAGE, "IMAGE", 0, "Image", ""},
+               {CAM_BGIMG_SOURCE_MOVIE, "MOVIE_CLIP", 0, "Movie Clip", ""},
+               {0, NULL, 0, NULL, NULL}
+       };
+
+       static const EnumPropertyItem bgpic_camera_frame_items[] = {
+               {0, "STRETCH", 0, "Stretch", ""},
+               {CAM_BGIMG_FLAG_CAMERA_ASPECT, "FIT", 0, "Fit", ""},
+               {CAM_BGIMG_FLAG_CAMERA_ASPECT | CAM_BGIMG_FLAG_CAMERA_CROP, "CROP", 0, "Crop", ""},
+               {0, NULL, 0, NULL, NULL}
+       };
+
+       static const EnumPropertyItem bgpic_display_depth_items[] = {
+               {0, "BACK", 0, "Back", ""},
+               {CAM_BGIMG_FLAG_FOREGROUND, "FRONT", 0, "Front", ""},
+               {0, NULL, 0, NULL, NULL}
+       };
+
+       srna = RNA_def_struct(brna, "CameraBackgroundImage", NULL);
+       RNA_def_struct_sdna(srna, "CameraBGImage");
+       RNA_def_struct_ui_text(srna, "Background Image", "Image and settings for display in the 3D View background");
+
+       prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
+       RNA_def_property_enum_sdna(prop, NULL, "source");
+       RNA_def_property_enum_items(prop, bgpic_source_items);
+       RNA_def_property_ui_text(prop, "Background Source", "Data source used for background");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "image", PROP_POINTER, PROP_NONE);
+       RNA_def_property_pointer_sdna(prop, NULL, "ima");
+       RNA_def_property_ui_text(prop, "Image", "Image displayed and edited in this space");
+       RNA_def_property_flag(prop, PROP_EDITABLE);
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "clip", PROP_POINTER, PROP_NONE);
+       RNA_def_property_pointer_sdna(prop, NULL, "clip");
+       RNA_def_property_ui_text(prop, "MovieClip", "Movie clip displayed and edited in this space");
+       RNA_def_property_flag(prop, PROP_EDITABLE);
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "image_user", PROP_POINTER, PROP_NONE);
+       RNA_def_property_flag(prop, PROP_NEVER_NULL);
+       RNA_def_property_pointer_sdna(prop, NULL, "iuser");
+       RNA_def_property_ui_text(prop, "Image User",
+                                "Parameters defining which layer, pass and frame of the image is displayed");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "clip_user", PROP_POINTER, PROP_NONE);
+       RNA_def_property_flag(prop, PROP_NEVER_NULL);
+       RNA_def_property_struct_type(prop, "MovieClipUser");
+       RNA_def_property_pointer_sdna(prop, NULL, "cuser");
+       RNA_def_property_ui_text(prop, "Clip User", "Parameters defining which frame of the movie clip is displayed");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "offset", PROP_FLOAT, PROP_XYZ);
+       RNA_def_property_float_sdna(prop, NULL, "offset");
+       RNA_def_property_ui_text(prop, "Offset", "");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "scale", PROP_FLOAT, PROP_FACTOR);
+       RNA_def_property_float_sdna(prop, NULL, "scale");
+       RNA_def_property_ui_text(prop, "Scale", "Scale the background image");
+       RNA_def_property_range(prop, 0.0, FLT_MAX);
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "rotation", PROP_FLOAT, PROP_ANGLE);
+       RNA_def_property_float_sdna(prop, NULL, "rotation");
+       RNA_def_property_ui_text(prop, "Rotation", "Rotation for the background image (ortho view only)");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "use_flip_x", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FLIP_X);
+       RNA_def_property_ui_text(prop, "Flip Horizontally", "Flip the background image horizontally");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "use_flip_y", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FLIP_Y);
+       RNA_def_property_ui_text(prop, "Flip Vertically", "Flip the background image vertically");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
+       RNA_def_property_float_sdna(prop, NULL, "alpha");
+       RNA_def_property_ui_text(prop, "Alpha", "Image opacity to blend the image against the background color");
+       RNA_def_property_range(prop, 0.0, 1.0);
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "show_expanded", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_EXPANDED);
+       RNA_def_property_ui_text(prop, "Show Expanded", "Show the expanded in the user interface");
+       RNA_def_property_ui_icon(prop, ICON_DISCLOSURE_TRI_RIGHT, 1);
+
+       prop = RNA_def_property(srna, "use_camera_clip", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_CAMERACLIP);
+       RNA_def_property_ui_text(prop, "Camera Clip", "Use movie clip from active scene camera");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "show_background_image", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_negative_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_DISABLED);
+       RNA_def_property_ui_text(prop, "Show Background Image", "Show this image as background");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       prop = RNA_def_property(srna, "show_on_foreground", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_BGIMG_FLAG_FOREGROUND);
+       RNA_def_property_ui_text(prop, "Show On Foreground", "Show this image in front of objects in viewport");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       /* expose 1 flag as a enum of 2 items */
+       prop = RNA_def_property(srna, "display_depth", PROP_ENUM, PROP_NONE);
+       RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
+       RNA_def_property_enum_items(prop, bgpic_display_depth_items);
+       RNA_def_property_ui_text(prop, "Depth", "Display under or over everything");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
+       /* expose 2 flags as a enum of 3 items */
+       prop = RNA_def_property(srna, "frame_method", PROP_ENUM, PROP_NONE);
+       RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
+       RNA_def_property_enum_items(prop, bgpic_camera_frame_items);
+       RNA_def_property_ui_text(prop, "Frame Method", "How the image fits in the camera frame");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+}
+
+
+static void rna_def_camera_background_images(BlenderRNA *brna, PropertyRNA *cprop)
+{
+       StructRNA *srna;
+       FunctionRNA *func;
+       PropertyRNA *parm;
+
+       RNA_def_property_srna(cprop, "CameraBackgroundImages");
+       srna = RNA_def_struct(brna, "CameraBackgroundImages", NULL);
+       RNA_def_struct_sdna(srna, "Camera");
+       RNA_def_struct_ui_text(srna, "Background Images", "Collection of background images");
+
+       func = RNA_def_function(srna, "new", "rna_Camera_background_images_new");
+       RNA_def_function_ui_description(func, "Add new background image");
+       parm = RNA_def_pointer(func, "image", "CameraBackgroundImage", "", "Image displayed as viewport background");
+       RNA_def_function_return(func, parm);
+
+       func = RNA_def_function(srna, "remove", "rna_Camera_background_images_remove");
+       RNA_def_function_ui_description(func, "Remove background image");
+       RNA_def_function_flag(func, FUNC_USE_REPORTS);
+       parm = RNA_def_pointer(func, "image", "CameraBackgroundImage", "", "Image displayed as viewport background");
+       RNA_def_parameter_flags(parm, PROP_NEVER_NULL, PARM_REQUIRED | PARM_RNAPTR);
+       RNA_def_parameter_clear_flags(parm, PROP_THICK_WRAP, 0);
+
+       func = RNA_def_function(srna, "clear", "rna_Camera_background_images_clear");
+       RNA_def_function_ui_description(func, "Remove all background images");
+}
+
 static void rna_def_camera_stereo_data(BlenderRNA *brna)
 {
        StructRNA *srna;
@@ -204,7 +390,7 @@ void RNA_def_camera(BlenderRNA *brna)
                {CAM_PANO, "PANO", 0, "Panoramic", ""},
                {0, NULL, 0, NULL, NULL}
        };
-       static const EnumPropertyItem prop_draw_type_extra_items[] = {
+       static const EnumPropertyItem prop_display_type_extra_items[] = {
                {CAM_DTX_CENTER, "CENTER", 0, "Center", ""},
                {CAM_DTX_CENTER_DIAG, "CENTER_DIAGONAL", 0, "Center Diagonal", ""},
                {CAM_DTX_THIRDS, "THIRDS", 0, "Thirds", ""},
@@ -239,9 +425,9 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "show_guide", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "dtx");
-       RNA_def_property_enum_items(prop, prop_draw_type_extra_items);
+       RNA_def_property_enum_items(prop, prop_display_type_extra_items);
        RNA_def_property_flag(prop, PROP_ENUM_FLAG);
-       RNA_def_property_ui_text(prop, "Composition Guides",  "Draw overlay");
+       RNA_def_property_ui_text(prop, "Composition Guides",  "Display overlay");
        RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
 
        prop = RNA_def_property(srna, "sensor_fit", PROP_ENUM, PROP_NONE);
@@ -254,6 +440,7 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "passepartout_alpha", PROP_FLOAT, PROP_FACTOR);
        RNA_def_property_float_sdna(prop, NULL, "passepartalpha");
+       RNA_def_property_float_default(prop, 0.5f);
        RNA_def_property_ui_text(prop, "Passepartout Alpha", "Opacity (alpha) of the darkened overlay in Camera view");
        RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
 
@@ -280,6 +467,7 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "clipsta");
+       RNA_def_property_float_default(prop, 0.1f);
        RNA_def_property_range(prop, 1e-6f, FLT_MAX);
        RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
        RNA_def_property_ui_text(prop, "Clip Start", "Camera near clipping distance");
@@ -287,6 +475,7 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
        RNA_def_property_float_sdna(prop, NULL, "clipend");
+       RNA_def_property_float_default(prop, 1000.0f);
        RNA_def_property_range(prop, 1e-6f, FLT_MAX);
        RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
        RNA_def_property_ui_text(prop, "Clip End", "Camera far clipping distance");
@@ -294,6 +483,7 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "lens", PROP_FLOAT, PROP_DISTANCE_CAMERA);
        RNA_def_property_float_sdna(prop, NULL, "lens");
+       RNA_def_property_float_default(prop, 50.0f);
        RNA_def_property_range(prop, 1.0f, FLT_MAX);
        RNA_def_property_ui_range(prop, 1.0f, 5000.0f, 1, 2);
        RNA_def_property_ui_text(prop, "Focal Length", "Perspective Camera lens value in millimeters");
@@ -301,6 +491,7 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "sensor_width", PROP_FLOAT, PROP_DISTANCE_CAMERA);
        RNA_def_property_float_sdna(prop, NULL, "sensor_x");
+       RNA_def_property_float_default(prop, 36.0f);
        RNA_def_property_range(prop, 1.0f, FLT_MAX);
        RNA_def_property_ui_range(prop, 1.0f, 100.f, 1, 2);
        RNA_def_property_ui_text(prop, "Sensor Width", "Horizontal size of the image sensor area in millimeters");
@@ -308,6 +499,7 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "sensor_height", PROP_FLOAT, PROP_DISTANCE_CAMERA);
        RNA_def_property_float_sdna(prop, NULL, "sensor_y");
+       RNA_def_property_float_default(prop, 34.0f);
        RNA_def_property_range(prop, 1.0f, FLT_MAX);
        RNA_def_property_ui_range(prop, 1.0f, 100.f, 1, 2);
        RNA_def_property_ui_text(prop, "Sensor Height", "Vertical size of the image sensor area in millimeters");
@@ -315,20 +507,22 @@ void RNA_def_camera(BlenderRNA *brna)
 
        prop = RNA_def_property(srna, "ortho_scale", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "ortho_scale");
+       RNA_def_property_float_default(prop, 6.0f);
        RNA_def_property_range(prop, FLT_MIN, FLT_MAX);
        RNA_def_property_ui_range(prop, 0.001f, 10000.0f, 10, 3);
        RNA_def_property_ui_text(prop, "Orthographic Scale", "Orthographic Camera scale (similar to zoom)");
        RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, "rna_Camera_update");
 
-       prop = RNA_def_property(srna, "draw_size", PROP_FLOAT, PROP_DISTANCE);
+       prop = RNA_def_property(srna, "display_size", PROP_FLOAT, PROP_DISTANCE);
 #if 0
        RNA_def_property_float_sdna(prop, NULL, "drawsize");
 #else
        RNA_def_property_float_funcs(prop, "rna_Camera_draw_size_get", "rna_Camera_draw_size_set", NULL);
 #endif
+       RNA_def_property_float_default(prop, 1.0f);
        RNA_def_property_range(prop, 0.01f, 1000.0f);
        RNA_def_property_ui_range(prop, 0.01, 100, 1, 2);
-       RNA_def_property_ui_text(prop, "Draw Size", "Apparent size of the Camera object in the 3D View");
+       RNA_def_property_ui_text(prop, "Display Size", "Apparent size of the Camera object in the 3D View");
        RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
 
        prop = RNA_def_property(srna, "shift_x", PROP_FLOAT, PROP_NONE);
@@ -362,16 +556,17 @@ void RNA_def_camera(BlenderRNA *brna)
        /* flag */
        prop = RNA_def_property(srna, "show_limits", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWLIMITS);
-       RNA_def_property_ui_text(prop, "Show Limits", "Draw the clipping range and focus point on the camera");
+       RNA_def_property_ui_text(prop, "Show Limits", "Display the clipping range and focus point on the camera");
        RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
 
        prop = RNA_def_property(srna, "show_mist", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWMIST);
-       RNA_def_property_ui_text(prop, "Show Mist", "Draw a line from the Camera to indicate the mist area");
+       RNA_def_property_ui_text(prop, "Show Mist", "Display a line from the Camera to indicate the mist area");
        RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
 
        prop = RNA_def_property(srna, "show_passepartout", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOWPASSEPARTOUT);
+       RNA_def_property_boolean_default(prop, true);
        RNA_def_property_ui_text(prop, "Show Passepartout",
                                 "Show a darkened overlay outside the image area in Camera view");
        RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
@@ -397,6 +592,12 @@ void RNA_def_camera(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "Show Sensor Size", "Show sensor size (film gate) in Camera view");
        RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
 
+       prop = RNA_def_property(srna, "show_background_images", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "flag", CAM_SHOW_BG_IMAGE);
+       RNA_def_property_ui_text(prop, "Display Background Images",
+                                "Display reference images behind objects in the 3D View");
+       RNA_def_property_update(prop, NC_CAMERA | ND_DRAW_RENDER_VIEWPORT, NULL);
+
        prop = RNA_def_property(srna, "lens_unit", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
        RNA_def_property_enum_items(prop, prop_lens_unit_items);
@@ -415,8 +616,17 @@ void RNA_def_camera(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "GPU Depth Of Field", "");
        RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
 
+       prop = RNA_def_property(srna, "background_images", PROP_COLLECTION, PROP_NONE);
+       RNA_def_property_collection_sdna(prop, NULL, "bg_images", NULL);
+       RNA_def_property_struct_type(prop, "CameraBackgroundImage");
+       RNA_def_property_ui_text(prop, "Background Images", "List of background images");
+       RNA_def_property_update(prop, NC_SPACE | ND_SPACE_VIEW3D, NULL);
+
        rna_def_animdata_common(srna);
 
+       rna_def_camera_background_image(brna);
+       rna_def_camera_background_images(brna, prop);
+
        /* Nested Data  */
        RNA_define_animate_sdna(true);