Blender V5.3
node_shader_volume_scatter.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2005 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "node_shader_util.hh"
10
11#include "BLI_string.hh"
12
14#include "UI_resources.hh"
15
16#include "BKE_node_runtime.hh"
17
18namespace blender {
19
21
23{
24 const bNodeTree *ntree = b.tree_or_null();
25 const bool is_gpu_internal = ntree && (ntree->flag & NTREE_IS_GPU_SHADER_INTERNAL);
26
27 b.add_input<decl::Color>("Color"_ustr).default_value({0.8f, 0.8f, 0.8f, 1.0f});
28#define SOCK_COLOR_ID 0
29 b.add_input<decl::Float>("Density"_ustr).default_value(1.0f).min(0.0f).max(1000.0f);
30#define SOCK_DENSITY_ID 1
31 b.add_input<decl::Float>("Anisotropy"_ustr)
32 .default_value(0.0f)
33 .min(-1.0f)
34 .max(1.0f)
36 .description(
37 "Directionality of the scattering. Zero is isotropic, negative is backward, "
38 "positive is forward")
39 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_HENYEY_GREENSTEIN; });
40 b.add_input<decl::Float>("IOR"_ustr)
41 .default_value(1.33f)
42 .min(1.0f)
43 .max(2.0f)
45 .description("Index Of Refraction of the scattering particles")
46 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_FOURNIER_FORAND; });
47 b.add_input<decl::Float>("Backscatter"_ustr)
48 .default_value(0.1f)
49 .min(0.0f)
50 .max(0.5f)
52 .description("Fraction of light that is scattered backwards")
53 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_FOURNIER_FORAND; });
54 b.add_input<decl::Float>("Alpha"_ustr)
55 .default_value(0.5f)
56 .min(0.0f)
57 .max(500.0f)
58 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_DRAINE; });
59 b.add_input<decl::Float>("Diameter"_ustr)
60 .default_value(20.0f)
61 .min(0.0f)
62 .max(50.0f)
63 .description("Diameter of the water droplets, in micrometers")
64 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_MIE; });
65 b.add_input<decl::Float>("Weight"_ustr).available(is_gpu_internal);
66 b.add_output<decl::Shader>("Volume"_ustr).translation_context(BLT_I18NCONTEXT_ID_ID);
67}
68
69static void node_shader_buts_scatter(ui::Layout &layout, bContext * /*C*/, PointerRNA *ptr)
70{
71 layout.prop(ptr, "phase", ui::ITEM_R_SPLIT_EMPTY_NAME, "", ICON_NONE);
72}
73
74static void node_shader_init_scatter(bNodeTree * /*ntree*/, bNode *node)
75{
77}
78
80{
81 const int phase_function = node->custom1;
82
83 for (bNodeSocket &sock : node->inputs) {
84 if (STR_ELEM(sock.name, "IOR", "Backscatter")) {
85 bke::node_set_socket_availability(*ntree, sock, phase_function == SHD_PHASE_FOURNIER_FORAND);
86 }
87 else if (STR_ELEM(sock.name, "Anisotropy")) {
89 *ntree, sock, ELEM(phase_function, SHD_PHASE_HENYEY_GREENSTEIN, SHD_PHASE_DRAINE));
90 }
91 else if (STR_ELEM(sock.name, "Alpha")) {
92 bke::node_set_socket_availability(*ntree, sock, phase_function == SHD_PHASE_DRAINE);
93 }
94 else if (STR_ELEM(sock.name, "Diameter")) {
95 bke::node_set_socket_availability(*ntree, sock, phase_function == SHD_PHASE_MIE);
96 }
97 }
98}
99
101 bNode *node,
102 bNodeExecData * /*execdata*/,
105{
106 if (in[SOCK_DENSITY_ID].socket_not_zero() && in[SOCK_COLOR_ID].socket_not_black()) {
107 /* Consider there is absorption phenomenon when there is scattering since
108 * `extinction = scattering + absorption`. */
110 }
111 return GPU_stack_link(
112 mat, node, "node_volume_scatter", in, out, GPU_kernel_globals(), GPU_shading_data());
113}
114
115#undef SOCK_COLOR_ID
116#undef SOCK_DENSITY_ID
117
118} // namespace nodes::node_shader_volume_scatter_cc
119
120/* node type definition */
122{
123 namespace file_ns = nodes::node_shader_volume_scatter_cc;
124
125 static bke::bNodeType ntype;
126
127 sh_node_type_base(&ntype, "ShaderNodeVolumeScatter"_ustr, SH_NODE_VOLUME_SCATTER);
128 ntype.ui_name = "Volume Scatter";
129 ntype.ui_description =
130 "Scatter light as it passes through the volume, often used to add fog to a scene";
131 ntype.enum_name_legacy = "VOLUME_SCATTER";
133 ntype.declare = file_ns::node_declare;
136 ntype.draw_buttons = file_ns::node_shader_buts_scatter;
138 ntype.initfunc = file_ns::node_shader_init_scatter;
139 ntype.gpu_fn = file_ns::node_shader_gpu_volume_scatter;
140 ntype.updatefunc = file_ns::node_shader_update_scatter;
141
143}
144
145} // namespace blender
#define NODE_CLASS_SHADER
Definition BKE_node.hh:491
#define SH_NODE_VOLUME_SCATTER
#define STR_ELEM(...)
#define BLT_I18NCONTEXT_ID_ID
#define ELEM(...)
void make_available(bNode &node) const
void node_register_type(bNodeType &ntype)
Definition node.cc:2920
void node_set_socket_availability(bNodeTree &ntree, bNodeSocket &sock, bool is_available)
Definition node.cc:5499
static int node_shader_gpu_volume_scatter(GPUMaterial *mat, bNode *node, bNodeExecData *, GPUNodeStack *in, GPUNodeStack *out)
static void node_shader_update_scatter(bNodeTree *ntree, bNode *node)
static void node_declare(NodeDeclarationBuilder &b)
static void node_shader_init_scatter(bNodeTree *, bNode *node)
static void node_shader_buts_scatter(ui::Layout &layout, bContext *, PointerRNA *ptr)
BMesh Iterators.
@ SHD_PHASE_HENYEY_GREENSTEIN
@ SHD_PHASE_FOURNIER_FORAND
bool GPU_stack_link(GPUMaterial *mat, const bNode *node, const char *name, GPUNodeStack *in, GPUNodeStack *out,...)
bool object_shader_nodes_poll(const bContext *C)
@ GPU_MATFLAG_VOLUME_ABSORPTION
@ GPU_MATFLAG_VOLUME_SCATTER
void sh_node_type_base(bke::bNodeType *ntype, UString idname, const std::optional< int16_t > legacy_type)
void register_node_type_sh_volume_scatter()
void search_link_ops_for_shader_bsdf_node(nodes::GatherLinkSearchOpParams &params)
void GPU_material_flag_set(GPUMaterial *mat, eGPUMaterialFlag flag)
GPUNodeLink * GPU_shading_data()
@ NTREE_IS_GPU_SHADER_INTERNAL
GPUNodeLink * GPU_kernel_globals()
@ PROP_FACTOR
Definition RNA_types.hh:308
#define SOCK_DENSITY_ID
#define SOCK_COLOR_ID
eNodeTree_Flag flag
static constexpr int _160
Definition BKE_node.hh:246
Defines a node type.
Definition BKE_node.hh:265
void(*) draw_buttons(ui::Layout &, bContext *C, PointerRNA *ptr)
Definition BKE_node.hh:290
std::string ui_description
Definition BKE_node.hh:271
void(*) updatefunc(bNodeTree *ntree, bNode *node)
Definition BKE_node.hh:312
NodeGPUExecFunction gpu_fn
Definition BKE_node.hh:373
void(*) initfunc(bNodeTree *ntree, bNode *node)
Definition BKE_node.hh:320
const char * enum_name_legacy
Definition BKE_node.hh:274
NodeGatherSocketLinkOperationsFunction gather_link_search_ops
Definition BKE_node.hh:409
NodeDeclareFunction declare
Definition BKE_node.hh:393
bool(*) add_ui_poll(const bContext *C)
Definition BKE_node.hh:341
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)