Merge branch 'master' of git@git.blender.org:blender.git into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_lightprobe.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.
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22
23 /** \file blender/makesrna/intern/rna_lightprobe.c
24  *  \ingroup RNA
25  */
26
27 #include <stdlib.h>
28
29 #include "RNA_define.h"
30 #include "RNA_enum_types.h"
31
32 #include "rna_internal.h"
33
34 #include "DNA_lightprobe_types.h"
35
36 #include "WM_types.h"
37
38 #ifdef RNA_RUNTIME
39
40 #include "DNA_object_types.h"
41
42 #include "MEM_guardedalloc.h"
43
44 #include "BKE_main.h"
45 #include "DEG_depsgraph.h"
46
47 #include "DNA_object_types.h"
48
49 #include "WM_api.h"
50 #include "WM_types.h"
51
52 static void rna_LightProbe_recalc(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
53 {
54         DEG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
55 }
56
57 #else
58
59 static EnumPropertyItem parallax_type_items[] = {
60         {LIGHTPROBE_SHAPE_ELIPSOID, "ELIPSOID", ICON_NONE, "Sphere", ""},
61         {LIGHTPROBE_SHAPE_BOX, "BOX", ICON_NONE, "Box", ""},
62         {0, NULL, 0, NULL, NULL}
63 };
64
65 static EnumPropertyItem lightprobe_type_items[] = {
66         {LIGHTPROBE_TYPE_CUBE, "CUBEMAP", ICON_NONE, "Reflection Cubemap", "Capture reflections"},
67         {LIGHTPROBE_TYPE_PLANAR, "PLANAR", ICON_NONE, "Reflection Plane", ""},
68         {LIGHTPROBE_TYPE_GRID, "GRID", ICON_NONE, "Irradiance Volume", "Volume used for precomputing indirect lighting"},
69         {0, NULL, 0, NULL, NULL}
70 };
71
72 static void rna_def_lightprobe(BlenderRNA *brna)
73 {
74         StructRNA *srna;
75         PropertyRNA *prop;
76
77         srna = RNA_def_struct(brna, "LightProbe", "ID");
78         RNA_def_struct_ui_text(srna, "LightProbe", "Light Probe data-block for lighting capture objects");
79         RNA_def_struct_ui_icon(srna, ICON_RADIO);
80
81         prop = RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
82         RNA_def_property_enum_items(prop, lightprobe_type_items);
83         RNA_def_property_ui_text(prop, "Type", "Type of light probe");
84         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
85
86         prop = RNA_def_property(srna, "clip_start", PROP_FLOAT, PROP_DISTANCE);
87         RNA_def_property_float_sdna(prop, NULL, "clipsta");
88         RNA_def_property_range(prop, 1e-6f, FLT_MAX);
89         RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
90         RNA_def_property_ui_text(prop, "Clip Start",
91                                  "Probe clip start, below which objects will not appear in reflections");
92         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, "rna_LightProbe_recalc");
93
94         prop = RNA_def_property(srna, "clip_end", PROP_FLOAT, PROP_DISTANCE);
95         RNA_def_property_float_sdna(prop, NULL, "clipend");
96         RNA_def_property_range(prop, 1e-6f, FLT_MAX);
97         RNA_def_property_ui_range(prop, 0.001f, FLT_MAX, 10, 3);
98         RNA_def_property_ui_text(prop, "Clip End",
99                                  "Probe clip end, beyond which objects will not appear in reflections");
100         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, "rna_LightProbe_recalc");
101
102         prop = RNA_def_property(srna, "show_clip", PROP_BOOLEAN, PROP_NONE);
103         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIGHTPROBE_FLAG_SHOW_CLIP_DIST);
104         RNA_def_property_ui_text(prop, "Clipping", "Show the clipping distances in the 3D view");
105         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
106
107         prop = RNA_def_property(srna, "influence_type", PROP_ENUM, PROP_NONE);
108         RNA_def_property_enum_sdna(prop, NULL, "attenuation_type");
109         RNA_def_property_enum_items(prop, parallax_type_items);
110         RNA_def_property_ui_text(prop, "Type", "Type of parallax volume");
111         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
112
113         prop = RNA_def_property(srna, "show_influence", PROP_BOOLEAN, PROP_NONE);
114         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIGHTPROBE_FLAG_SHOW_INFLUENCE);
115         RNA_def_property_ui_text(prop, "Influence", "Show the influence volume in the 3D view");
116         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
117
118         prop = RNA_def_property(srna, "influence_distance", PROP_FLOAT, PROP_DISTANCE);
119         RNA_def_property_float_sdna(prop, NULL, "distinf");
120         RNA_def_property_range(prop, 0.0f, FLT_MAX);
121         RNA_def_property_ui_text(prop, "Influence Distance", "Influence distance of the probe");
122         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
123
124         prop = RNA_def_property(srna, "falloff", PROP_FLOAT, PROP_FACTOR);
125         RNA_def_property_range(prop, 0.0f, 1.0f);
126         RNA_def_property_ui_text(prop, "Falloff", "Control how fast the probe influence decreases");
127         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
128
129         prop = RNA_def_property(srna, "use_custom_parallax", PROP_BOOLEAN, PROP_NONE);
130         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIGHTPROBE_FLAG_CUSTOM_PARALLAX);
131         RNA_def_property_ui_text(prop, "Use Custom Parallax", "Enable custom settings for the parallax correction volume");
132         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
133
134         prop = RNA_def_property(srna, "show_parallax", PROP_BOOLEAN, PROP_NONE);
135         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIGHTPROBE_FLAG_SHOW_PARALLAX);
136         RNA_def_property_ui_text(prop, "Parallax", "Show the parallax correction volume in the 3D view");
137         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
138
139         prop = RNA_def_property(srna, "parallax_type", PROP_ENUM, PROP_NONE);
140         RNA_def_property_enum_items(prop, parallax_type_items);
141         RNA_def_property_ui_text(prop, "Type", "Type of parallax volume");
142         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
143
144         prop = RNA_def_property(srna, "parallax_distance", PROP_FLOAT, PROP_DISTANCE);
145         RNA_def_property_float_sdna(prop, NULL, "distpar");
146         RNA_def_property_range(prop, 0.0f, FLT_MAX);
147         RNA_def_property_ui_text(prop, "Parallax Radius", "Lowest corner of the parallax bounding box");
148         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
149
150         /* irradiance grid */
151         prop = RNA_def_property(srna, "grid_resolution_x", PROP_INT, PROP_NONE);
152         RNA_def_property_range(prop, 1, 256);
153         RNA_def_property_ui_text(prop, "Resolution X", "Number of sample along the x axis of the volume");
154         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, "rna_LightProbe_recalc");
155
156         prop = RNA_def_property(srna, "grid_resolution_y", PROP_INT, PROP_NONE);
157         RNA_def_property_range(prop, 1, 256);
158         RNA_def_property_ui_text(prop, "Resolution Y", "Number of sample along the y axis of the volume");
159         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, "rna_LightProbe_recalc");
160
161         prop = RNA_def_property(srna, "grid_resolution_z", PROP_INT, PROP_NONE);
162         RNA_def_property_range(prop, 1, 256);
163         RNA_def_property_ui_text(prop, "Resolution Z", "Number of sample along the z axis of the volume");
164         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, "rna_LightProbe_recalc");
165
166         /* Data preview */
167         prop = RNA_def_property(srna, "show_data", PROP_BOOLEAN, PROP_NONE);
168         RNA_def_property_boolean_sdna(prop, NULL, "flag", LIGHTPROBE_FLAG_SHOW_DATA);
169         RNA_def_property_ui_text(prop, "Show Data", "Show captured lighting data into the 3D view for debuging purpose");
170         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
171
172         prop = RNA_def_property(srna, "data_draw_size", PROP_FLOAT, PROP_NONE);
173         RNA_def_property_range(prop, 0.05f, 10.0f);
174         RNA_def_property_ui_text(prop, "Data Draw Size", "Size of the spheres to debug captured light");
175         RNA_def_property_update(prop, NC_MATERIAL | ND_SHADING, NULL);
176
177         /* common */
178         rna_def_animdata_common(srna);
179 }
180
181
182 void RNA_def_lightprobe(BlenderRNA *brna)
183 {
184         rna_def_lightprobe(brna);
185 }
186
187 #endif
188