Code refactor: add generic Cycles node infrastructure.
[blender.git] / intern / cycles / graph / node_type.h
1 /*
2  * Copyright 2011-2016 Blender Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #pragma once
18
19 #include "node_enum.h"
20
21 #include "util_map.h"
22 #include "util_param.h"
23 #include "util_string.h"
24
25 CCL_NAMESPACE_BEGIN
26
27 struct Node;
28 struct NodeType;
29
30 /* Socket Type */
31
32 struct SocketType
33 {
34         enum Type
35         {
36                 UNDEFINED,
37
38                 BOOLEAN,
39                 FLOAT,
40                 INT,
41                 COLOR,
42                 VECTOR,
43                 POINT,
44                 NORMAL,
45                 POINT2,
46                 CLOSURE,
47                 STRING,
48                 ENUM,
49                 TRANSFORM,
50                 NODE,
51
52                 BOOLEAN_ARRAY,
53                 FLOAT_ARRAY,
54                 INT_ARRAY,
55                 COLOR_ARRAY,
56                 VECTOR_ARRAY,
57                 POINT_ARRAY,
58                 NORMAL_ARRAY,
59                 POINT2_ARRAY,
60                 STRING_ARRAY,
61                 TRANSFORM_ARRAY,
62                 NODE_ARRAY,
63         };
64
65         enum Flags {
66                 LINKABLE               = (1 << 0),
67                 ANIMATABLE             = (1 << 1),
68
69                 SVM_INTERNAL           = (1 << 2),
70                 OSL_INTERNAL           = (1 << 3),
71                 INTERNAL               = (1 << 2) | (1 << 3),
72
73                 LINK_TEXTURE_GENERATED = (1 << 4),
74                 LINK_TEXTURE_UV        = (1 << 5),
75                 LINK_INCOMING          = (1 << 6),
76                 LINK_NORMAL            = (1 << 7),
77                 LINK_POSITION          = (1 << 8),
78                 LINK_TANGENT           = (1 << 9),
79                 DEFAULT_LINK_MASK      = (1 << 4) | (1 << 5) | (1 << 6) | (1 << 7) | (1 << 8) | (1 << 9)
80         };
81
82         ustring name;
83         Type type;
84         int struct_offset;
85         const void *default_value;
86         const NodeEnum *enum_values;
87         const NodeType **node_type;
88         int flags;
89         ustring ui_name;
90
91         size_t size() const;
92         bool is_array() const;
93         static size_t size(Type type);
94         static size_t max_size();
95         static ustring type_name(Type type);
96         static void *zero_default_value();
97 };
98
99 /* Node Type */
100
101 struct NodeType
102 {
103         explicit NodeType();
104         ~NodeType();
105
106         void register_input(ustring name, ustring ui_name, SocketType::Type type,
107                             int struct_offset, const void *default_value,
108                                                 const NodeEnum *enum_values = NULL,
109                                                 const NodeType **node_type = NULL,
110                                                 int flags = 0, int extra_flags = 0);
111         void register_output(ustring name, ustring ui_name, SocketType::Type type);
112
113         typedef Node *(*CreateFunc)(const NodeType *type);
114         typedef unordered_map<ustring, SocketType, ustringHash> SocketMap;
115
116         ustring name;
117         SocketMap inputs;
118         SocketMap outputs;
119         CreateFunc create;
120
121         static NodeType *add(const char *name, CreateFunc create);
122         static const NodeType *find(ustring name);
123         static unordered_map<ustring, NodeType, ustringHash>& types();
124 };
125
126 /* Node Definition Macros */
127
128 #define NODE_DECLARE                       \
129 template<typename T>                       \
130 static const NodeType *register_type();    \
131 static Node *create(const NodeType *type); \
132 static const NodeType *node_type;
133
134 #define NODE_DEFINE(structname)                                                  \
135 const NodeType *structname::node_type = structname::register_type<structname>(); \
136 Node *structname::create(const NodeType*) { return new structname(); }           \
137 template<typename T>                                                             \
138 const NodeType *structname::register_type()
139
140 /* Sock Definition Macros */
141
142 #define SOCKET_OFFSETOF(T, name) (((char *)&(((T *)1)->name)) - (char *)1)
143 #define SOCKET_SIZEOF(T, name) (sizeof(((T *)1)->name))
144 #define SOCKET_DEFINE(name, ui_name, default_value, datatype, TYPE, flags, ...) \
145         { \
146                 static datatype defval = default_value; \
147                 assert(SOCKET_SIZEOF(T, name) == sizeof(datatype)); \
148                 type->register_input(ustring(#name), ustring(ui_name), TYPE, SOCKET_OFFSETOF(T, name), &defval, NULL, NULL, flags, ##__VA_ARGS__); \
149         }
150
151 #define SOCKET_BOOLEAN(name, ui_name, default_value, ...) \
152         SOCKET_DEFINE(name, ui_name, default_value, bool, SocketType::BOOLEAN, 0, ##__VA_ARGS__)
153 #define SOCKET_INT(name, ui_name, default_value, ...) \
154         SOCKET_DEFINE(name, ui_name, default_value, int, SocketType::INT, 0, ##__VA_ARGS__)
155 #define SOCKET_FLOAT(name, ui_name, default_value, ...) \
156         SOCKET_DEFINE(name, ui_name, default_value, float, SocketType::FLOAT, 0, ##__VA_ARGS__)
157 #define SOCKET_COLOR(name, ui_name, default_value, ...) \
158         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::COLOR, 0, ##__VA_ARGS__)
159 #define SOCKET_VECTOR(name, ui_name, default_value, ...) \
160         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::VECTOR, 0, ##__VA_ARGS__)
161 #define SOCKET_POINT(name, ui_name, default_value, ...) \
162         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::POINT, 0, ##__VA_ARGS__)
163 #define SOCKET_NORMAL(name, ui_name, default_value, ...) \
164         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::NORMAL, 0, ##__VA_ARGS__)
165 #define SOCKET_POINT2(name, ui_name, default_value, ...) \
166         SOCKET_DEFINE(name, ui_name, default_value, float2, SocketType::POINT2, 0, ##__VA_ARGS__)
167 #define SOCKET_STRING(name, ui_name, default_value, ...) \
168         SOCKET_DEFINE(name, ui_name, default_value, ustring, SocketType::STRING, 0, ##__VA_ARGS__)
169 #define SOCKET_TRANSFORM(name, ui_name, default_value, ...) \
170         SOCKET_DEFINE(name, ui_name, default_value, Transform, SocketType::TRANSFORM, 0, ##__VA_ARGS__)
171 #define SOCKET_ENUM(name, ui_name, values, default_value, ...) \
172         { \
173                 static int defval = default_value; \
174                 assert(SOCKET_SIZEOF(T, name) == sizeof(int)); \
175                 type->register_input(ustring(#name), ustring(ui_name), SocketType::ENUM, SOCKET_OFFSETOF(T, name), &defval, &values, NULL, ##__VA_ARGS__); \
176         }
177 #define SOCKET_NODE(name, ui_name, node_type, ...) \
178         { \
179             static Node *defval = NULL; \
180                 assert(SOCKET_SIZEOF(T, name) == sizeof(Node*)); \
181                 type->register_input(ustring(#name), ustring(ui_name), SocketType::NODE, SOCKET_OFFSETOF(T, name), &defval, NULL, node_type, ##__VA_ARGS__); \
182         }
183
184 #define SOCKET_BOOLEAN_ARRAY(name, ui_name, default_value, ...) \
185         SOCKET_DEFINE(name, ui_name, default_value, array<bool>, SocketType::BOOLEAN_ARRAY, 0, ##__VA_ARGS__)
186 #define SOCKET_INT_ARRAY(name, ui_name, default_value, ...) \
187         SOCKET_DEFINE(name, ui_name, default_value, array<int>, SocketType::INT_ARRAY, 0, ##__VA_ARGS__)
188 #define SOCKET_FLOAT_ARRAY(name, ui_name, default_value, ...) \
189         SOCKET_DEFINE(name, ui_name, default_value, array<float>, SocketType::FLOAT_ARRAY, 0, ##__VA_ARGS__)
190 #define SOCKET_COLOR_ARRAY(name, ui_name, default_value, ...) \
191         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::COLOR_ARRAY, 0, ##__VA_ARGS__)
192 #define SOCKET_VECTOR_ARRAY(name, ui_name, default_value, ...) \
193         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::VECTOR_ARRAY, 0, ##__VA_ARGS__)
194 #define SOCKET_POINT_ARRAY(name, ui_name, default_value, ...) \
195         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::POINT_ARRAY, 0, ##__VA_ARGS__)
196 #define SOCKET_NORMAL_ARRAY(name, ui_name, default_value, ...) \
197         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::NORMAL_ARRAY, 0, ##__VA_ARGS__)
198 #define SOCKET_POINT2_ARRAY(name, ui_name, default_value, ...) \
199         SOCKET_DEFINE(name, ui_name, default_value, array<float2>, SocketType::POINT2_ARRAY, 0, ##__VA_ARGS__)
200 #define SOCKET_STRING_ARRAY(name, ui_name, default_value, ...) \
201         SOCKET_DEFINE(name, ui_name, default_value, array<ustring>, SocketType::STRING_ARRAY, 0, ##__VA_ARGS__)
202 #define SOCKET_TRANSFORM_ARRAY(name, ui_name, default_value, ...) \
203         SOCKET_DEFINE(name, ui_name, default_value, array<Transform>, SocketType::TRANSFORM_ARRAY, 0, ##__VA_ARGS__)
204 #define SOCKET_NODE_ARRAY(name, ui_name, node_type, ...) \
205         { \
206             static Node *defval = NULL; \
207                 assert(SOCKET_SIZEOF(T, name) == sizeof(Node*)); \
208                 type->register_input(ustring(#name), ustring(ui_name), SocketType::NODE_ARRAY, SOCKET_OFFSETOF(T, name), &defval, NULL, node_type, ##__VA_ARGS__); \
209         }
210
211 #define SOCKET_IN_BOOLEAN(name, ui_name, default_value, ...) \
212         SOCKET_DEFINE(name, ui_name, default_value, bool, SocketType::BOOLEAN, SocketType::LINKABLE, ##__VA_ARGS__)
213 #define SOCKET_IN_INT(name, ui_name, default_value, ...) \
214         SOCKET_DEFINE(name, ui_name, default_value, int, SocketType::INT, SocketType::LINKABLE, ##__VA_ARGS__)
215 #define SOCKET_IN_FLOAT(name, ui_name, default_value, ...) \
216         SOCKET_DEFINE(name, ui_name, default_value, float, SocketType::FLOAT, SocketType::LINKABLE, ##__VA_ARGS__)
217 #define SOCKET_IN_COLOR(name, ui_name, default_value, ...) \
218         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::COLOR, SocketType::LINKABLE, ##__VA_ARGS__)
219 #define SOCKET_IN_VECTOR(name, ui_name, default_value, ...) \
220         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::VECTOR, SocketType::LINKABLE, ##__VA_ARGS__)
221 #define SOCKET_IN_POINT(name, ui_name, default_value, ...) \
222         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::POINT, SocketType::LINKABLE, ##__VA_ARGS__)
223 #define SOCKET_IN_NORMAL(name, ui_name, default_value, ...) \
224         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::NORMAL, SocketType::LINKABLE, ##__VA_ARGS__)
225 #define SOCKET_IN_STRING(name, ui_name, default_value, ...) \
226         SOCKET_DEFINE(name, ui_name, default_value, ustring, SocketType::STRING, SocketType::LINKABLE, ##__VA_ARGS__)
227 #define SOCKET_IN_CLOSURE(name, ui_name, ...) \
228         type->register_input(ustring(#name), ustring(ui_name), SocketType::CLOSURE, 0, NULL, NULL, NULL, SocketType::LINKABLE, ##__VA_ARGS__)
229
230 #define SOCKET_OUT_BOOLEAN(name, ui_name) \
231         { type->register_output(ustring(#name), ustring(ui_name), SocketType::BOOLEAN); }
232 #define SOCKET_OUT_INT(name, ui_name) \
233         { type->register_output(ustring(#name), ustring(ui_name), SocketType::INT); }
234 #define SOCKET_OUT_FLOAT(name, ui_name) \
235         { type->register_output(ustring(#name), ustring(ui_name), SocketType::FLOAT); }
236 #define SOCKET_OUT_COLOR(name, ui_name) \
237         { type->register_output(ustring(#name), ustring(ui_name), SocketType::COLOR); }
238 #define SOCKET_OUT_VECTOR(name, ui_name) \
239         { type->register_output(ustring(#name), ustring(ui_name), SocketType::VECTOR); }
240 #define SOCKET_OUT_POINT(name, ui_name) \
241         { type->register_output(ustring(#name), ustring(ui_name), SocketType::POINT); }
242 #define SOCKET_OUT_NORMAL(name, ui_name) \
243         { type->register_output(ustring(#name), ustring(ui_name), SocketType::NORMAL); }
244 #define SOCKET_OUT_CLOSURE(name, ui_name) \
245         { type->register_output(ustring(#name), ustring(ui_name), SocketType::CLOSURE); }
246 #define SOCKET_OUT_STRING(name, ui_name) \
247         { type->register_output(ustring(#name), ustring(ui_name), SocketType::STRING); }
248 #define SOCKET_OUT_ENUM(name, ui_name) \
249         { type->register_output(ustring(#name), ustring(ui_name), SocketType::ENUM); }
250
251 CCL_NAMESPACE_END
252