Blender V5.3
node_shader_vector_transform.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2013 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include "node_shader_util.hh"
10#include "node_util.hh"
11
13#include "UI_resources.hh"
14
15namespace blender {
16
18
20{
21 const bNodeTree *ntree = b.tree_or_null();
22 const bool is_gpu_internal = ntree && (ntree->flag & NTREE_IS_GPU_SHADER_INTERNAL);
23
24 b.add_input<decl::Int>("LightIndex"_ustr).available(is_gpu_internal);
25
26 b.add_input<decl::Vector>("Vector"_ustr)
27 .default_value({0.5f, 0.5f, 0.5f})
28 .min(-10000.0f)
29 .max(10000.0f)
30 .description("Vector, point, or normal which will be used for conversion between spaces");
31 b.add_output<decl::Vector>("Vector"_ustr);
32}
33
35{
36 layout.prop(ptr,
37 "vector_type",
39 std::nullopt,
40 ICON_NONE);
41 layout.prop(ptr, "convert_from", ui::ITEM_R_SPLIT_EMPTY_NAME, "", ICON_NONE);
42 layout.prop(ptr, "convert_to", ui::ITEM_R_SPLIT_EMPTY_NAME, "", ICON_NONE);
43}
44
46{
47 NodeShaderVectTransform *vect = MEM_new<NodeShaderVectTransform>("NodeShaderVectTransform");
48
49 /* Convert World into Object Space per default. */
51
52 node->storage = vect;
53}
54
55static const char *get_gpufn_name_from_to(short from, short to, short vector_type)
56{
57 if (from == to) {
58 return nullptr;
59 }
60
61#define SWITCH_VECTOR_TYPE(FROM, TO) \
62 switch (vector_type) { \
63 case SHD_VECT_TRANSFORM_TYPE_NORMAL: \
64 return "normal_transform_" FROM "_to_" TO; \
65 case SHD_VECT_TRANSFORM_TYPE_VECTOR: \
66 return "direction_transform_" FROM "_to_" TO; \
67 case SHD_VECT_TRANSFORM_TYPE_POINT: \
68 return "point_transform_" FROM "_to_" TO; \
69 } \
70 break;
71
72#define SWITCH_SPACE_TYPE(FROM) \
73 switch (to) { \
74 case SHD_VECT_TRANSFORM_SPACE_WORLD: \
75 SWITCH_VECTOR_TYPE(FROM, "world"); \
76 case SHD_VECT_TRANSFORM_SPACE_OBJECT: \
77 SWITCH_VECTOR_TYPE(FROM, "object"); \
78 case SHD_VECT_TRANSFORM_SPACE_CAMERA: \
79 SWITCH_VECTOR_TYPE(FROM, "view"); \
80 case SHD_VECT_TRANSFORM_SPACE_LIGHT: \
81 SWITCH_VECTOR_TYPE(FROM, "light"); \
82 } \
83 break;
84
85 switch (from) {
87 SWITCH_SPACE_TYPE("world");
89 SWITCH_SPACE_TYPE("object");
91 SWITCH_SPACE_TYPE("view");
93 SWITCH_SPACE_TYPE("light");
94 }
95
97 return nullptr;
98
99#undef SWITCH_VECTOR_SPACE
100#undef SWITCH_VECTOR_TYPE
101}
102
104 bNode *node,
105 bNodeExecData * /*execdata*/,
108{
109 GPUNodeLink *inputlink;
110
111 NodeShaderVectTransform *nodeprop = static_cast<NodeShaderVectTransform *>(node->storage);
112
113 const bool has_light_space = ELEM(
115
116 if (has_light_space && !in[0].link) {
117 /* Error: not linked to a light accumulation zone. */
119 return false;
120 }
121
122 if (in[1].hasinput) {
123 inputlink = in[1].link;
124 }
125 else {
126 inputlink = GPU_uniform(in[1]);
127 }
128
129 const char *func_name = get_gpufn_name_from_to(
130 nodeprop->convert_from, nodeprop->convert_to, nodeprop->type);
131
132 if (func_name) {
133 /* For cycles we have inverted Z */
134 /* TODO: pass here the correct matrices */
137 {
138 GPU_link(mat, "invert_z", inputlink, &inputlink);
139 }
140
141 if (has_light_space) {
142 GPU_link(mat,
143 func_name,
144 in[0].link,
145 inputlink,
148 &out[0].link);
149 }
150 else {
151 GPU_link(mat, func_name, inputlink, GPU_kernel_globals(), GPU_shading_data(), &out[0].link);
152 }
153
156 {
157 GPU_link(mat, "invert_z", out[0].link, &out[0].link);
158 }
159 }
160 else {
161 GPU_link(mat, "set_rgb", inputlink, &out[0].link);
162 }
163
164 if (nodeprop->type == SHD_VECT_TRANSFORM_TYPE_NORMAL) {
165 GPU_link(mat, "vector_normalize", out[0].link, &out[0].link);
166 }
167
168 return true;
169}
170
172#ifdef WITH_MATERIALX
173{
174 NodeItem res = empty();
175 NodeShaderVectTransform *nodeprop = (NodeShaderVectTransform *)node_->storage;
176 std::string fromspace;
177 std::string tospace;
178 std::string category;
179 NodeItem vector = get_input_value("Vector", NodeItem::Type::Vector3);
180
181 switch (nodeprop->convert_from) {
183 fromspace = "world";
184 break;
186 fromspace = "object";
187 break;
188 default:
189 /* NOTE: SHD_VECT_TRANSFORM_SPACE_CAMERA/LIGHT don't have an implementation in MaterialX. */
191 return vector;
192 }
193
194 switch (nodeprop->convert_to) {
196 tospace = "world";
197 break;
199 tospace = "object";
200 break;
201 default:
202 /* NOTE: SHD_VECT_TRANSFORM_SPACE_CAMERA/LIGHT don't have an implementation in MaterialX. */
204 return vector;
205 }
206
207 if (fromspace == tospace) {
208 return vector;
209 }
210
211 switch (nodeprop->type) {
213 category = "transformpoint";
214 break;
216 category = "transformnormal";
217 break;
219 category = "transformvector";
220 break;
221 default:
223 return vector;
224 }
225
226 return create_node(category,
227 NodeItem::Type::Vector3,
228 {{"in", vector}, {"fromspace", val(fromspace)}, {"tospace", val(tospace)}});
229}
230#endif
232
233} // namespace nodes::node_shader_vector_transform_cc
234
236{
237 namespace file_ns = nodes::node_shader_vector_transform_cc;
238
239 static bke::bNodeType ntype;
240
241 sh_node_type_base(&ntype, "ShaderNodeVectorTransform"_ustr, SH_NODE_VECT_TRANSFORM);
242 ntype.ui_name = "Vector Transform";
243 ntype.ui_description =
244 "Convert a vector, point, or normal between world, camera, and object coordinate space";
245 ntype.enum_name_legacy = "VECT_TRANSFORM";
247 ntype.declare = file_ns::node_declare;
248 ntype.draw_buttons = file_ns::node_shader_buts_vect_transform;
249 ntype.initfunc = file_ns::node_shader_init_vect_transform;
251 ntype, "NodeShaderVectTransform", node_free_standard_storage, node_copy_standard_storage);
253 ntype.gpu_fn = file_ns::gpu_shader_vect_transform;
254 ntype.materialx_fn = file_ns::node_shader_materialx;
255
257}
258
259} // namespace blender
#define NODE_CLASS_OP_VECTOR
Definition BKE_node.hh:481
#define SH_NODE_VECT_TRANSFORM
#define BLI_assert_unreachable()
#define ELEM(...)
void node_register_type(bNodeType &ntype)
Definition node.cc:2920
void node_type_storage(bNodeType &ntype, std::optional< StringRefNull > storagename, void(*freefunc)(bNode *node), void(*copyfunc)(bNodeTree *dest_ntree, bNode *dest_node, const bNode *src_node))
Definition node.cc:6166
static void node_shader_buts_vect_transform(ui::Layout &layout, bContext *, PointerRNA *ptr)
static int gpu_shader_vect_transform(GPUMaterial *mat, bNode *node, bNodeExecData *, GPUNodeStack *in, GPUNodeStack *out)
static const char * get_gpufn_name_from_to(short from, short to, short vector_type)
static void node_shader_init_vect_transform(bNodeTree *, bNode *node)
BMesh Iterators.
@ SHD_VECT_TRANSFORM_TYPE_POINT
@ SHD_VECT_TRANSFORM_TYPE_NORMAL
@ SHD_VECT_TRANSFORM_TYPE_VECTOR
void sh_node_type_base(bke::bNodeType *ntype, UString idname, const std::optional< int16_t > legacy_type)
GPUNodeLink * GPU_uniform(const float *num)
bool GPU_link(GPUMaterial *mat, const char *name,...)
@ SHD_VECT_TRANSFORM_SPACE_WORLD
@ SHD_VECT_TRANSFORM_SPACE_CAMERA
@ SHD_VECT_TRANSFORM_SPACE_OBJECT
@ SHD_VECT_TRANSFORM_SPACE_LIGHT
GPUNodeLink * GPU_shading_data()
@ NTREE_IS_GPU_SHADER_INTERNAL
GPUNodeLink * GPU_kernel_globals()
void node_copy_standard_storage(bNodeTree *, bNode *dest_node, const bNode *src_node)
Definition node_util.cc:57
void node_free_standard_storage(bNode *node)
Definition node_util.cc:45
void search_link_ops_for_shader_material_lighting_node(nodes::GatherLinkSearchOpParams &params)
void register_node_type_sh_vect_transform()
std::vector< ElementType, Eigen::aligned_allocator< ElementType > > vector
#define NODE_SHADER_MATERIALX_BEGIN
#define NODE_SHADER_MATERIALX_END
#define SWITCH_SPACE_TYPE(FROM)
#define min(a, b)
Definition sort.cc:38
eNodeTree_Flag flag
Defines a node type.
Definition BKE_node.hh:265
NodeMaterialXFunction materialx_fn
Definition BKE_node.hh:375
void(*) draw_buttons(ui::Layout &, bContext *C, PointerRNA *ptr)
Definition BKE_node.hh:290
std::string ui_description
Definition BKE_node.hh:271
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
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)