Blender V5.3
rna_world.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cfloat>
10#include <cstdlib>
11
12#include "RNA_define.hh"
13
15
16#include "rna_internal.hh"
17
18#include "DNA_world_types.h"
19
20#include "WM_types.hh"
21
22#ifdef RNA_RUNTIME
23
24# include "BKE_context.hh"
25# include "BKE_layer.hh"
26# include "BKE_main.hh"
27# include "BKE_texture.h"
28
29# include "DEG_depsgraph.hh"
30# include "DEG_depsgraph_build.hh"
31
32# include "ED_node.hh"
33
34# include "WM_api.hh"
35
36namespace blender {
37
38static PointerRNA rna_World_lighting_get(PointerRNA *ptr)
39{
40 return RNA_pointer_create_with_parent(*ptr, RNA_WorldLighting, ptr->owner_id);
41}
42
43static PointerRNA rna_World_mist_get(PointerRNA *ptr)
44{
45 return RNA_pointer_create_with_parent(*ptr, RNA_WorldMistSettings, ptr->owner_id);
46}
47
48static void rna_World_update(Main * /*bmain*/, Scene * /*scene*/, PointerRNA *ptr)
49{
50 World *wo = id_cast<World *>(ptr->owner_id);
51
52 DEG_id_tag_update(&wo->id, 0);
54}
55
56# if 0
57static void rna_World_draw_update(Main * /*bmain*/, Scene * /*scene*/, PointerRNA *ptr)
58{
59 World *wo = (World *)ptr->owner_id;
60
61 DEG_id_tag_update(&wo->id, 0);
63}
64# endif
65
66static void rna_World_draw_update(Main * /*bmain*/, Scene * /*scene*/, PointerRNA *ptr)
67{
68 World *wo = id_cast<World *>(ptr->owner_id);
69
70 DEG_id_tag_update(&wo->id, 0);
73}
74
75void rna_World_lightgroup_get(PointerRNA *ptr, char *value)
76{
77 LightgroupMembership *lgm = (id_cast<World *>(ptr->owner_id))->lightgroup;
78 char value_buf[sizeof(lgm->name)];
79 int len = BKE_lightgroup_membership_get(lgm, value_buf);
80 memcpy(value, value_buf, len + 1);
81}
82
83int rna_World_lightgroup_length(PointerRNA *ptr)
84{
85 LightgroupMembership *lgm = (id_cast<World *>(ptr->owner_id))->lightgroup;
87}
88
89void rna_World_lightgroup_set(PointerRNA *ptr, const char *value)
90{
91 BKE_lightgroup_membership_set(&(id_cast<World *>(ptr->owner_id))->lightgroup, value);
92}
93
94bool rna_World_use_nodes_get(PointerRNA * /*ptr*/)
95{
96 /* #use_nodes is deprecated. Worlds always use nodes. */
97 return true;
98}
99
100void rna_World_use_nodes_set(PointerRNA * /*ptr*/, bool /*new_value*/)
101{
102 /* #use_nodes is deprecated. Setting the property has no effect.
103 * Note: Users will get a warning through the RNA deprecation warning, so no need to log a
104 * warning here. */
105}
106
107} // namespace blender
108
109#else
110
111namespace blender {
112
114 {LIGHT_PROBE_RESOLUTION_128, "128", 0, "128", ""},
115 {LIGHT_PROBE_RESOLUTION_256, "256", 0, "256", ""},
116 {LIGHT_PROBE_RESOLUTION_512, "512", 0, "512", ""},
117 {LIGHT_PROBE_RESOLUTION_1024, "1024", 0, "1024", ""},
118 {LIGHT_PROBE_RESOLUTION_2048, "2048", 0, "2048", ""},
119 {LIGHT_PROBE_RESOLUTION_4096, "4096", 0, "4096", ""},
120 {0, nullptr, 0, nullptr, nullptr},
121};
122
123static void rna_def_lighting(BlenderRNA *brna)
124{
125 StructRNA *srna;
126 PropertyRNA *prop;
127
128 srna = RNA_def_struct(brna, "WorldLighting", nullptr);
129 RNA_def_struct_sdna(srna, "World");
130 RNA_def_struct_nested(brna, srna, "World");
131 RNA_def_struct_ui_text(srna, "Lighting", "Lighting for a World data-block");
132
133 /* ambient occlusion */
134 prop = RNA_def_property(srna, "ao_factor", PROP_FLOAT, PROP_FACTOR);
135 RNA_def_property_float_sdna(prop, nullptr, "aoenergy");
137 RNA_def_property_ui_range(prop, 0, 1, 0.1, 2);
138 RNA_def_property_ui_text(prop, "Factor", "Factor for ambient occlusion blending");
139 RNA_def_property_update(prop, 0, "rna_World_update");
140
141 prop = RNA_def_property(srna, "distance", PROP_FLOAT, PROP_DISTANCE);
142 RNA_def_property_float_sdna(prop, nullptr, "aodist");
145 prop, "Distance", "Length of rays, defines how far away other faces give occlusion effect");
146 RNA_def_property_update(prop, 0, "rna_World_update");
147}
148
150{
151 StructRNA *srna;
152 PropertyRNA *prop;
153
154 static const EnumPropertyItem falloff_items[] = {
155 {WO_MIST_QUADRATIC, "QUADRATIC", 0, "Quadratic", "Use quadratic progression"},
156 {WO_MIST_LINEAR, "LINEAR", 0, "Linear", "Use linear progression"},
158 "INVERSE_QUADRATIC",
159 0,
160 "Inverse Quadratic",
161 "Use inverse quadratic progression"},
162 {0, nullptr, 0, nullptr, nullptr},
163 };
164
165 srna = RNA_def_struct(brna, "WorldMistSettings", nullptr);
166 RNA_def_struct_sdna(srna, "World");
167 RNA_def_struct_nested(brna, srna, "World");
168 RNA_def_struct_ui_text(srna, "World Mist", "Mist settings for a World data-block");
169
170 prop = RNA_def_property(srna, "use_mist", PROP_BOOLEAN, PROP_NONE);
171 RNA_def_property_boolean_sdna(prop, nullptr, "mode", WO_MIST);
173 prop, "Use Mist", "Occlude objects with the environment color as they are further away");
174 RNA_def_property_update(prop, 0, "rna_World_draw_update");
175
176 prop = RNA_def_property(srna, "intensity", PROP_FLOAT, PROP_NONE);
177 RNA_def_property_float_sdna(prop, nullptr, "misi");
178 RNA_def_property_range(prop, 0, 1);
179 RNA_def_property_ui_text(prop, "Minimum", "Overall minimum intensity of the mist effect");
180 RNA_def_property_update(prop, 0, "rna_World_draw_update");
181
182 prop = RNA_def_property(srna, "start", PROP_FLOAT, PROP_DISTANCE);
183 RNA_def_property_float_sdna(prop, nullptr, "miststa");
185 RNA_def_property_ui_range(prop, 0, 10000, 10, 2);
187 prop, "Start", "Starting distance of the mist, measured from the camera");
188 RNA_def_property_update(prop, 0, "rna_World_draw_update");
189
190 prop = RNA_def_property(srna, "depth", PROP_FLOAT, PROP_DISTANCE);
191 RNA_def_property_float_sdna(prop, nullptr, "mistdist");
193 RNA_def_property_ui_range(prop, 0, 10000, 10, 2);
194 RNA_def_property_ui_text(prop, "Depth", "Distance over which the mist effect fades in");
195 RNA_def_property_update(prop, 0, "rna_World_draw_update");
196
197 prop = RNA_def_property(srna, "height", PROP_FLOAT, PROP_DISTANCE);
198 RNA_def_property_float_sdna(prop, nullptr, "misthi");
199 RNA_def_property_range(prop, 0, 100);
200 RNA_def_property_ui_text(prop, "Height", "Control how much mist density decreases with height");
201 RNA_def_property_update(prop, 0, "rna_World_update");
202
203 prop = RNA_def_property(srna, "falloff", PROP_ENUM, PROP_NONE);
204 RNA_def_property_enum_sdna(prop, nullptr, "mistype");
205 RNA_def_property_enum_items(prop, falloff_items);
206 RNA_def_property_ui_text(prop, "Falloff", "Type of transition used to fade mist");
207 RNA_def_property_update(prop, 0, "rna_World_draw_update");
208}
209
211{
212 StructRNA *srna;
213 PropertyRNA *prop;
214
215 static const float default_world_color[] = {0.05f, 0.05f, 0.05f};
216
217 srna = RNA_def_struct(brna, "World", "ID");
219 srna,
220 "World",
221 "World data-block describing the environment and ambient lighting of a scene");
222 RNA_def_struct_ui_icon(srna, ICON_WORLD_DATA);
223
225
226 /* Flags */
227 prop = RNA_def_property(srna, "use_eevee_finite_volume", PROP_BOOLEAN, PROP_NONE);
230 "Finite Volume",
231 "The world's volume used to be rendered by EEVEE Legacy. Conversion is "
232 "needed for it to render properly.");
234
235 /* colors */
236 prop = RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
237 RNA_def_property_float_sdna(prop, nullptr, "horr");
238 RNA_def_property_array(prop, 3);
239 RNA_def_property_float_array_default(prop, default_world_color);
240 RNA_def_property_ui_text(prop, "Color", "Color of the background");
241 // RNA_def_property_update(prop, 0, "rna_World_update");
242 /* render-only uses this */
243 RNA_def_property_update(prop, 0, "rna_World_draw_update");
244
245 /* nested structs */
246 prop = RNA_def_property(srna, "light_settings", PROP_POINTER, PROP_NONE);
248 RNA_def_property_struct_type(prop, "WorldLighting");
249 RNA_def_property_pointer_funcs(prop, "rna_World_lighting_get", nullptr, nullptr, nullptr);
250 RNA_def_property_ui_text(prop, "Lighting", "World lighting settings");
251
252 prop = RNA_def_property(srna, "mist_settings", PROP_POINTER, PROP_NONE);
254 RNA_def_property_struct_type(prop, "WorldMistSettings");
255 RNA_def_property_pointer_funcs(prop, "rna_World_mist_get", nullptr, nullptr, nullptr);
256 RNA_def_property_ui_text(prop, "Mist", "World mist settings");
257
258 /* nodes */
259 prop = RNA_def_property(srna, "node_tree", PROP_POINTER, PROP_NONE);
260 RNA_def_property_pointer_sdna(prop, nullptr, "nodetree");
263 RNA_def_property_ui_text(prop, "Node Tree", "Node tree for node based worlds");
264
265 prop = RNA_def_property(srna, "use_nodes", PROP_BOOLEAN, PROP_NONE);
266 RNA_def_property_boolean_sdna(prop, nullptr, "use_nodes", 1);
269 RNA_def_property_ui_text(prop, "Use Nodes", "Use shader nodes to render the world");
270 RNA_def_property_boolean_funcs(prop, "rna_World_use_nodes_get", "rna_World_use_nodes_set");
272 "Unused but kept for compatibility reasons. Setting the property "
273 "has no effect, and getting it always returns True.",
274 500,
275 600);
276
277 /* Lightgroup Membership */
278 prop = RNA_def_property(srna, "lightgroup", PROP_STRING, PROP_NONE);
280 prop, "rna_World_lightgroup_get", "rna_World_lightgroup_length", "rna_World_lightgroup_set");
282 RNA_def_property_ui_text(prop, "Lightgroup", "Lightgroup that the world belongs to");
283 RNA_def_property_update(prop, 0, "rna_World_draw_update");
284
285 /* Reflection Probe Baking. */
286 prop = RNA_def_property(srna, "probe_resolution", PROP_ENUM, PROP_NONE);
287 RNA_def_property_enum_sdna(prop, nullptr, "probe_resolution");
289 RNA_def_property_ui_text(prop, "Resolution", "Resolution when baked to a texture");
290 RNA_def_property_update(prop, 0, "rna_World_draw_update");
291
292 prop = RNA_def_property(srna, "sun_threshold", PROP_FLOAT, PROP_NONE);
294 "Sun Threshold",
295 "If non-zero, the maximum value for world contribution that will be "
296 "recorded inside the world light probe. The excess contribution is "
297 "converted to a sun light. This reduces the light bleeding caused by "
298 "very bright light sources.");
299 RNA_def_property_range(prop, 0.0f, FLT_MAX);
300 RNA_def_property_update(prop, 0, "rna_World_draw_update");
301
302 prop = RNA_def_property(srna, "sun_angle", PROP_FLOAT, PROP_ANGLE);
303 RNA_def_property_range(prop, DEG2RADF(0.0f), DEG2RADF(180.0f));
305 prop, "Sun Angle", "Angular diameter of the Sun as seen from the Earth");
306 RNA_def_property_update(prop, 0, "rna_World_draw_update");
307
308 prop = RNA_def_property(srna, "use_sun_shadow", PROP_BOOLEAN, PROP_NONE);
309 RNA_def_property_boolean_sdna(prop, nullptr, "flag", WO_USE_SUN_SHADOW);
310 RNA_def_property_ui_text(prop, "Use Shadow", "Enable sun shadow casting");
311 RNA_def_property_update(prop, 0, "rna_World_draw_update");
312
313 prop = RNA_def_property(srna, "sun_shadow_maximum_resolution", PROP_FLOAT, PROP_DISTANCE);
314 RNA_def_property_range(prop, 0.0f, FLT_MAX);
315 RNA_def_property_ui_range(prop, 0.0001f, 0.020f, 0.05f, 4);
317 "Shadows Resolution Limit",
318 "Maximum size of a shadow map pixel. Higher values use less memory at "
319 "the cost of shadow quality.");
321 RNA_def_property_update(prop, 0, "rna_World_draw_update");
322
323 prop = RNA_def_property(srna, "sun_shadow_filter_radius", PROP_FLOAT, PROP_NONE);
324 RNA_def_property_range(prop, 0.0f, FLT_MAX);
325 RNA_def_property_ui_range(prop, 0.0f, 5.0f, 1.0f, 2);
327 prop, "Shadow Filter Radius", "Blur shadow aliasing using Percentage Closer Filtering");
329 RNA_def_property_update(prop, 0, "rna_World_draw_update");
330
331 prop = RNA_def_property(srna, "use_sun_shadow_jitter", PROP_BOOLEAN, PROP_NONE);
334 prop,
335 "Shadow Jitter",
336 "Enable jittered soft shadows to increase shadow precision (disabled in viewport unless "
337 "enabled in the render settings). Has a high performance impact.");
339 RNA_def_property_update(prop, 0, "rna_World_draw_update");
340
341 prop = RNA_def_property(srna, "sun_shadow_jitter_overblur", PROP_FLOAT, PROP_PERCENTAGE);
342 RNA_def_property_range(prop, 0.0f, 100.0f);
343 RNA_def_property_ui_range(prop, 0.0f, 20.0f, 10.0f, 0);
345 prop,
346 "Shadow Jitter Overblur",
347 "Apply shadow tracing to each jittered sample to reduce under-sampling artifacts");
349 RNA_def_property_update(prop, 0, "rna_World_draw_update");
350
351 rna_def_lighting(brna);
352 rna_def_world_mist(brna);
353}
354
355} // namespace blender
356
357#endif
#define DEG2RADF(_deg)
#define NC_WORLD
Definition WM_types.hh:400
#define ND_WORLD
Definition WM_types.hh:471
#define ND_DRAW
Definition WM_types.hh:502
#define ND_WORLD_DRAW
Definition WM_types.hh:530
#define NC_OBJECT
Definition WM_types.hh:392
#define FLT_MAX
#define INT_MAX
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
BMesh Iterators.
void WM_main_add_notifier(uint type, void *reference)
void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description)
void RNA_def_property_ui_text(PropertyRNA *prop, const char *name, const char *description)
void RNA_def_property_deprecated(PropertyRNA *prop, const char *note, const short version, const short removal_version)
void RNA_def_struct_ui_icon(StructRNA *srna, int icon)
void RNA_def_property_pointer_sdna(PropertyRNA *prop, const char *structname, const char *propname)
void RNA_def_property_pointer_funcs(PropertyRNA *prop, const char *get, const char *set, const char *type_fn, const char *poll)
void RNA_def_property_boolean_funcs(PropertyRNA *prop, const char *get, const char *set)
int BKE_lightgroup_membership_get(const LightgroupMembership *lgm, char *name)
@ WO_USE_EEVEE_FINITE_VOLUME
@ WO_USE_SUN_SHADOW_JITTER
void RNA_def_property_struct_type(PropertyRNA *prop, const char *type)
void BKE_lightgroup_membership_set(LightgroupMembership **lgm, const char *name)
void RNA_def_struct_nested(BlenderRNA *brna, StructRNA *srna, const char *structname)
void RNA_def_property_float_array_default(PropertyRNA *prop, const float *array)
void RNA_def_property_ui_range(PropertyRNA *prop, double min, double max, double step, int precision)
void RNA_def_property_float_sdna(PropertyRNA *prop, const char *structname, const char *propname)
@ PROPOVERRIDE_OVERRIDABLE_LIBRARY
Definition RNA_types.hh:588
void rna_def_animdata_common(StructRNA *srna)
PropertyRNA * RNA_def_property(StructOrFunctionRNA *cont_, const char *identifier_c_str, int type, int subtype)
void RNA_def_struct_sdna(StructRNA *srna, const char *structname)
void RNA_def_property_enum_items(PropertyRNA *prop, const EnumPropertyItem *item)
@ WO_MIST_INVERSE_QUADRATIC
@ PROP_BOOLEAN
Definition RNA_types.hh:210
@ PROP_POINTER
Definition RNA_types.hh:215
@ PROP_STRING
Definition RNA_types.hh:213
void DEG_id_tag_update(ID *id, unsigned int flags)
void RNA_def_property_override_flag(PropertyRNA *prop, PropertyOverrideFlag flag)
void RNA_def_property_boolean_sdna(PropertyRNA *prop, const char *structname, const char *propname, int64_t booleanbit)
void RNA_def_property_range(PropertyRNA *prop, double min, double max)
static const EnumPropertyItem world_probe_resolution_items[]
Definition rna_world.cc:113
@ LIGHT_PROBE_RESOLUTION_512
@ LIGHT_PROBE_RESOLUTION_4096
@ LIGHT_PROBE_RESOLUTION_2048
@ LIGHT_PROBE_RESOLUTION_256
@ LIGHT_PROBE_RESOLUTION_128
@ LIGHT_PROBE_RESOLUTION_1024
void RNA_def_property_enum_sdna(PropertyRNA *prop, const char *structname, const char *propname)
void RNA_def_property_clear_flag(PropertyRNA *prop, PropertyFlag flag)
void RNA_def_property_flag(PropertyRNA *prop, PropertyFlag flag)
StructRNA * RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from)
@ PROP_CONTEXT_UPDATE
Definition RNA_types.hh:477
@ PROP_EDITABLE
Definition RNA_types.hh:376
@ PROP_PTR_NO_OWNERSHIP
Definition RNA_types.hh:465
@ PROP_NEVER_NULL
Definition RNA_types.hh:447
@ PROP_ANIMATABLE
Definition RNA_types.hh:389
void RNA_def_property_update(PropertyRNA *prop, int noteflag, const char *func)
PointerRNA RNA_pointer_create_with_parent(const PointerRNA &parent, StructRNA *type, void *data)
void RNA_def_world(BlenderRNA *brna)
Definition rna_world.cc:210
void RNA_def_property_string_funcs(PropertyRNA *prop, const char *get, const char *length, const char *set)
@ PROP_PERCENTAGE
Definition RNA_types.hh:307
@ PROP_FACTOR
Definition RNA_types.hh:308
@ PROP_DISTANCE
Definition RNA_types.hh:313
void RNA_def_property_array(PropertyRNA *prop, int length)
static void rna_def_lighting(BlenderRNA *brna)
Definition rna_world.cc:123
static void rna_def_world_mist(BlenderRNA *brna)
Definition rna_world.cc:149
int BKE_lightgroup_membership_length(const LightgroupMembership *lgm)