1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
|
/*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef __BKE_NODE_TREE_FUNCTION_HH__
#define __BKE_NODE_TREE_FUNCTION_HH__
/** \file
* \ingroup bke
*
* This file allows you to generate a multi-function network from a user-generated node tree.
*/
#include "FN_multi_function_builder.hh"
#include "FN_multi_function_network.hh"
#include "BKE_derived_node_tree.hh"
#include "BLI_resource_collector.hh"
namespace blender {
namespace bke {
/* Maybe this should be moved to BKE_node.h. */
inline bool is_multi_function_data_socket(const bNodeSocket *bsocket)
{
if (bsocket->typeinfo->get_mf_data_type != nullptr) {
BLI_assert(bsocket->typeinfo->expand_in_mf_network != nullptr);
return true;
}
return false;
}
/**
* A MFNetworkTreeMap maps various components of a bke::DerivedNodeTree to components of a
* fn::MFNetwork. This is necessary for further processing of a multi-function network that has
* been generated from a node tree.
*/
class MFNetworkTreeMap {
private:
/**
* Store by id instead of using a hash table to avoid unnecessary hash table lookups.
*
* Input sockets in a node tree can have multiple corresponding sockets in the generated
* MFNetwork. This is because nodes are allowed to expand into multiple multi-function nodes.
*/
const DerivedNodeTree &tree_;
fn::MFNetwork &network_;
Array<Vector<fn::MFSocket *, 1>> sockets_by_dsocket_id_;
Array<fn::MFOutputSocket *> socket_by_group_input_id_;
public:
MFNetworkTreeMap(const DerivedNodeTree &tree, fn::MFNetwork &network)
: tree_(tree),
network_(network),
sockets_by_dsocket_id_(tree.sockets().size()),
socket_by_group_input_id_(tree.group_inputs().size(), nullptr)
{
}
const DerivedNodeTree &tree() const
{
return tree_;
}
const fn::MFNetwork &network() const
{
return network_;
}
void add(const DSocket &dsocket, fn::MFSocket &socket)
{
BLI_assert(dsocket.is_input() == socket.is_input());
sockets_by_dsocket_id_[dsocket.id()].append(&socket);
}
void add(const DInputSocket &dsocket, fn::MFInputSocket &socket)
{
sockets_by_dsocket_id_[dsocket.id()].append(&socket);
}
void add(const DOutputSocket &dsocket, fn::MFOutputSocket &socket)
{
sockets_by_dsocket_id_[dsocket.id()].append(&socket);
}
void add(Span<const DInputSocket *> dsockets, Span<fn::MFInputSocket *> sockets)
{
assert_same_size(dsockets, sockets);
for (uint i : dsockets.index_range()) {
this->add(*dsockets[i], *sockets[i]);
}
}
void add(Span<const DOutputSocket *> dsockets, Span<fn::MFOutputSocket *> sockets)
{
assert_same_size(dsockets, sockets);
for (uint i : dsockets.index_range()) {
this->add(*dsockets[i], *sockets[i]);
}
}
void add(const DGroupInput &group_input, fn::MFOutputSocket &socket)
{
BLI_assert(socket_by_group_input_id_[group_input.id()] == nullptr);
socket_by_group_input_id_[group_input.id()] = &socket;
}
void add_try_match(const DNode &dnode, fn::MFNode &node)
{
this->add_try_match(dnode.inputs(), node.inputs());
this->add_try_match(dnode.outputs(), node.outputs());
}
void add_try_match(Span<const DSocket *> dsockets, Span<fn::MFSocket *> sockets)
{
uint used_sockets = 0;
for (const DSocket *dsocket : dsockets) {
if (!dsocket->is_available()) {
continue;
}
if (!is_multi_function_data_socket(dsocket->bsocket())) {
continue;
}
fn::MFSocket *socket = sockets[used_sockets];
this->add(*dsocket, *socket);
used_sockets++;
}
}
fn::MFOutputSocket &lookup(const DGroupInput &group_input)
{
fn::MFOutputSocket *socket = socket_by_group_input_id_[group_input.id()];
BLI_assert(socket != nullptr);
return *socket;
}
fn::MFOutputSocket &lookup(const DOutputSocket &dsocket)
{
auto &sockets = sockets_by_dsocket_id_[dsocket.id()];
BLI_assert(sockets.size() == 1);
return sockets[0]->as_output();
}
Span<fn::MFInputSocket *> lookup(const DInputSocket &dsocket)
{
return sockets_by_dsocket_id_[dsocket.id()].as_span().cast<fn::MFInputSocket *>();
}
fn::MFInputSocket &lookup_dummy(const DInputSocket &dsocket)
{
Span<fn::MFInputSocket *> sockets = this->lookup(dsocket);
BLI_assert(sockets.size() == 1);
fn::MFInputSocket &socket = *sockets[0];
BLI_assert(socket.node().is_dummy());
return socket;
}
fn::MFOutputSocket &lookup_dummy(const DOutputSocket &dsocket)
{
fn::MFOutputSocket &socket = this->lookup(dsocket);
BLI_assert(socket.node().is_dummy());
return socket;
}
bool is_mapped(const DSocket &dsocket) const
{
return sockets_by_dsocket_id_[dsocket.id()].size() >= 1;
}
};
/**
* This data is necessary throughout the generation of a MFNetwork from a node tree.
*/
struct CommonMFNetworkBuilderData {
ResourceCollector &resources;
fn::MFNetwork &network;
MFNetworkTreeMap &network_map;
const DerivedNodeTree &tree;
};
class MFNetworkBuilderBase {
protected:
CommonMFNetworkBuilderData &common_;
public:
MFNetworkBuilderBase(CommonMFNetworkBuilderData &common) : common_(common)
{
}
/**
* Returns the network that is currently being built.
*/
fn::MFNetwork &network()
{
return common_.network;
}
/**
* Returns the map between the node tree and the multi-function network that is being built.
*/
MFNetworkTreeMap &network_map()
{
return common_.network_map;
}
/**
* Returns a resource collector that will only be destructed after the multi-function network is
* destructed.
*/
ResourceCollector &resources()
{
return common_.resources;
}
/**
* Constructs a new function that will live at least as long as the MFNetwork.
*/
template<typename T, typename... Args> T &construct_fn(Args &&... args)
{
BLI_STATIC_ASSERT((std::is_base_of_v<fn::MultiFunction, T>), "");
void *buffer = common_.resources.linear_allocator().allocate(sizeof(T), alignof(T));
T *fn = new (buffer) T(std::forward<Args>(args)...);
common_.resources.add(destruct_ptr<T>(fn), fn->name().data());
return *fn;
}
};
/**
* This class is used by socket implementations to define how an unlinked input socket is handled
* in a multi-function network.
*/
class SocketMFNetworkBuilder : public MFNetworkBuilderBase {
private:
const DSocket *dsocket_ = nullptr;
const DGroupInput *group_input_ = nullptr;
bNodeSocket *bsocket_;
fn::MFOutputSocket *built_socket_ = nullptr;
public:
SocketMFNetworkBuilder(CommonMFNetworkBuilderData &common, const DSocket &dsocket)
: MFNetworkBuilderBase(common), dsocket_(&dsocket), bsocket_(dsocket.bsocket())
{
}
SocketMFNetworkBuilder(CommonMFNetworkBuilderData &common, const DGroupInput &group_input)
: MFNetworkBuilderBase(common), group_input_(&group_input), bsocket_(group_input.bsocket())
{
}
/**
* Returns the socket that is currently being built.
*/
bNodeSocket &bsocket()
{
return *bsocket_;
}
/**
* Utility method that returns bsocket->default_value for the current socket.
*/
template<typename T> T *socket_default_value()
{
return (T *)bsocket_->default_value;
}
/**
* Builds a function node for that socket that outputs the given constant value.
*/
template<typename T> void set_constant_value(T value)
{
const fn::MultiFunction &fn = this->construct_fn<fn::CustomMF_Constant<T>>(std::move(value));
this->set_generator_fn(fn);
}
/**
* Uses the first output of the given multi-function as value of the socket.
*/
void set_generator_fn(const fn::MultiFunction &fn)
{
fn::MFFunctionNode &node = common_.network.add_function(fn);
this->set_socket(node.output(0));
}
/**
* Define a multi-function socket that outputs the value of the bsocket.
*/
void set_socket(fn::MFOutputSocket &socket)
{
built_socket_ = &socket;
}
fn::MFOutputSocket *built_socket()
{
return built_socket_;
}
};
/**
* This class is used by node implementations to define how a user-level node expands into
* multi-function nodes internally.
*/
class NodeMFNetworkBuilder : public MFNetworkBuilderBase {
private:
const DNode &node_;
public:
NodeMFNetworkBuilder(CommonMFNetworkBuilderData &common, const DNode &node)
: MFNetworkBuilderBase(common), node_(node)
{
}
/**
* Tells the builder to build a function that corresponds to the node that is being built. It
* will try to match up sockets.
*/
template<typename T, typename... Args> void construct_and_set_matching_fn(Args &&... args)
{
const fn::MultiFunction &function = this->construct_fn<T>(std::forward<Args>(args)...);
this->set_matching_fn(function);
}
/**
* Tells the builder that the given function corresponds to the node that is being built. It will
* try to match up sockets. For that it skips unavailable and non-data sockets.
*/
void set_matching_fn(const fn::MultiFunction &function)
{
fn::MFFunctionNode &node = common_.network.add_function(function);
common_.network_map.add_try_match(node_, node);
}
/**
* Returns the node that is currently being built.
*/
bNode &bnode()
{
return *node_.node_ref().bnode();
}
/**
* Returns the node that is currently being built.
*/
const DNode &dnode() const
{
return node_;
}
};
MFNetworkTreeMap insert_node_tree_into_mf_network(fn::MFNetwork &network,
const DerivedNodeTree &tree,
ResourceCollector &resources);
} // namespace bke
} // namespace blender
#endif /* __BKE_NODE_TREE_FUNCTION_HH__ */
|