Blender V5.3
node_shader_volume_coefficients.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 "BLI_string.hh"
10
11#include "node_shader_util.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.use_custom_socket_order();
28
29 b.add_output<decl::Shader>("Volume"_ustr).translation_context(BLT_I18NCONTEXT_ID_ID);
30
31 b.add_input<decl::Float>("Weight"_ustr).available(is_gpu_internal);
32#define SOCK_WEIGHT_ID 0
33
34 PanelDeclarationBuilder &abs = b.add_panel("Absorption"_ustr).default_closed(false);
35 abs.add_input<decl::Vector>("Absorption Coefficients"_ustr)
36 .default_value({1.0f, 1.0f, 1.0f})
37 .min(0.0f)
38 .max(1000.0f)
39 .description(
40 "Probability density per color channel that light is absorbed per unit distance "
41 "traveled in the medium");
42#define SOCK_ABSORPTION_COEFFICIENTS_ID 1
43 PanelDeclarationBuilder &sca = b.add_panel("Scatter"_ustr).default_closed(false);
44 sca.add_layout([](ui::Layout &layout, bContext * /*C*/, PointerRNA *ptr) {
45 layout.prop(ptr, "phase", ui::ITEM_R_SPLIT_EMPTY_NAME, "", ICON_NONE);
46 });
47 sca.add_input<decl::Vector>("Scatter Coefficients"_ustr)
48 .default_value({1.0f, 1.0f, 1.0f})
49 .min(0.0f)
50 .max(1000.0f)
51 .description(
52 "Probability density per color channel of an out-scattering event occurring per unit "
53 "distance");
54#define SOCK_SCATTER_COEFFICIENTS_ID 2
55 sca.add_input<decl::Float>("Anisotropy"_ustr)
56 .default_value(0.0f)
57 .min(-1.0f)
58 .max(1.0f)
60 .description(
61 "Directionality of the scattering. Zero is isotropic, negative is backward, "
62 "positive is forward")
63 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_HENYEY_GREENSTEIN; });
64#define SOCK_SCATTER_ANISOTROPY_ID 3
65 sca.add_input<decl::Float>("IOR"_ustr)
66 .default_value(1.33f)
67 .min(1.0f)
68 .max(2.0f)
70 .description("Index Of Refraction of the scattering particles")
71 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_FOURNIER_FORAND; });
72#define SOCK_SCATTER_IOR_ID 4
73 sca.add_input<decl::Float>("Backscatter"_ustr)
74 .default_value(0.1f)
75 .min(0.0f)
76 .max(0.5f)
78 .description("Fraction of light that is scattered backwards")
79 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_FOURNIER_FORAND; });
80#define SOCK_SCATTER_BACKSCATTER_ID 5
81 sca.add_input<decl::Float>("Alpha"_ustr)
82 .default_value(0.5f)
83 .min(0.0f)
84 .max(500.0f)
85 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_DRAINE; });
86#define SOCK_SCATTER_ALPHA_ID 6
87 sca.add_input<decl::Float>("Diameter"_ustr)
88 .default_value(20.0f)
89 .min(0.0f)
90 .max(50.0f)
91 .description("Diameter of the water droplets, in micrometers")
92 .make_available([](bNode &node) { node.custom1 = SHD_PHASE_MIE; });
93#define SOCK_SCATTER_DIAMETER_ID 7
94 PanelDeclarationBuilder &emi = b.add_panel("Emission"_ustr).default_closed(false);
95 emi.add_input<decl::Vector>("Emission Coefficients"_ustr)
96 .default_value({0.0f, 0.0f, 0.0f})
97 .min(0.0f)
98 .max(1000.0f)
99 .description("Emitted radiance per color channel that is added to a ray per unit distance");
100#define SOCK_EMISSION_COEFFICIENTS_ID 8
101}
102
104{
106}
107
109{
110 const int phase_function = node->custom1;
111
112 for (bNodeSocket &sock : node->inputs) {
113 if (STR_ELEM(sock.name, "IOR", "Backscatter")) {
114 bke::node_set_socket_availability(*ntree, sock, phase_function == SHD_PHASE_FOURNIER_FORAND);
115 }
116 else if (STR_ELEM(sock.name, "Anisotropy")) {
118 *ntree, sock, ELEM(phase_function, SHD_PHASE_HENYEY_GREENSTEIN, SHD_PHASE_DRAINE));
119 }
120 else if (STR_ELEM(sock.name, "Alpha")) {
121 bke::node_set_socket_availability(*ntree, sock, phase_function == SHD_PHASE_DRAINE);
122 }
123 else if (STR_ELEM(sock.name, "Diameter")) {
124 bke::node_set_socket_availability(*ntree, sock, phase_function == SHD_PHASE_MIE);
125 }
126 }
127}
128
130 bNode *node,
131 bNodeExecData * /*execdata*/,
134{
135 if (in[SOCK_SCATTER_COEFFICIENTS_ID].socket_not_black()) {
137 }
138 if (in[SOCK_ABSORPTION_COEFFICIENTS_ID].socket_not_black()) {
140 }
141 return GPU_stack_link(
142 mat, node, "node_volume_coefficients", in, out, GPU_kernel_globals(), GPU_shading_data());
143}
144
145#undef SOCK_WEIGHT_ID
146#undef SOCK_ABSORPTION_COEFFICIENTS_ID
147#undef SOCK_SCATTER_COEFFICIENTS_ID
148#undef SOCK_SCATTER_ANISOTROPY_ID
149#undef SOCK_SCATTER_IOR_ID
150#undef SOCK_SCATTER_BACKSCATTER_ID
151#undef SOCK_SCATTER_ALPHA_ID
152#undef SOCK_SCATTER_DIAMETER_ID
153#undef SOCK_EMISSION_COEFFICIENTS_ID
154
155} // namespace nodes::node_shader_volume_coefficients_cc
156
157/* node type definition */
159{
161
162 static bke::bNodeType ntype;
163
164 sh_node_type_base(&ntype, "ShaderNodeVolumeCoefficients"_ustr, SH_NODE_VOLUME_COEFFICIENTS);
165 ntype.ui_name = "Volume Coefficients";
166 ntype.ui_description =
167 "Model all three physical processes in a volume, represented by their coefficients";
168 ntype.enum_name_legacy = "VOLUME_COEFFICIENTS";
170 ntype.declare = file_ns::node_declare;
174 ntype.initfunc = file_ns::node_shader_init_coefficients;
175 ntype.gpu_fn = file_ns::node_shader_gpu_volume_coefficients;
176 ntype.updatefunc = file_ns::node_shader_update_coefficients;
177
179}
180
181} // namespace blender
#define NODE_CLASS_SHADER
Definition BKE_node.hh:491
#define SH_NODE_VOLUME_COEFFICIENTS
#define STR_ELEM(...)
#define BLT_I18NCONTEXT_ID_ID
#define ELEM(...)
DeclType::Builder & add_input(UString name, UString identifier=""_ustr)
void add_layout(std::function< void(ui::Layout &, bContext *, PointerRNA *)> draw)
void make_available(bNode &node) const
#define abs
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_coefficients(GPUMaterial *mat, bNode *node, bNodeExecData *, GPUNodeStack *in, GPUNodeStack *out)
static void node_shader_update_coefficients(bNodeTree *ntree, bNode *node)
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 search_link_ops_for_shader_bsdf_node(nodes::GatherLinkSearchOpParams &params)
void GPU_material_flag_set(GPUMaterial *mat, eGPUMaterialFlag flag)
void register_node_type_sh_volume_coefficients()
GPUNodeLink * GPU_shading_data()
@ NTREE_IS_GPU_SHADER_INTERNAL
GPUNodeLink * GPU_kernel_globals()
@ PROP_FACTOR
Definition RNA_types.hh:308
#define SOCK_ABSORPTION_COEFFICIENTS_ID
#define SOCK_SCATTER_COEFFICIENTS_ID
#define min(a, b)
Definition sort.cc:38
eNodeTree_Flag flag
static constexpr int _240
Definition BKE_node.hh:250
Defines a node type.
Definition BKE_node.hh:265
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)