Code refactor: minor node and node type utility functions and changes.
[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 #include "util_vector.h"
25
26 CCL_NAMESPACE_BEGIN
27
28 struct Node;
29 struct NodeType;
30
31 /* Socket Type */
32
33 struct SocketType
34 {
35         enum Type
36         {
37                 UNDEFINED,
38
39                 BOOLEAN,
40                 FLOAT,
41                 INT,
42                 COLOR,
43                 VECTOR,
44                 POINT,
45                 NORMAL,
46                 POINT2,
47                 CLOSURE,
48                 STRING,
49                 ENUM,
50                 TRANSFORM,
51                 NODE,
52
53                 BOOLEAN_ARRAY,
54                 FLOAT_ARRAY,
55                 INT_ARRAY,
56                 COLOR_ARRAY,
57                 VECTOR_ARRAY,
58                 POINT_ARRAY,
59                 NORMAL_ARRAY,
60                 POINT2_ARRAY,
61                 STRING_ARRAY,
62                 TRANSFORM_ARRAY,
63                 NODE_ARRAY,
64         };
65
66         enum Flags {
67                 LINKABLE               = (1 << 0),
68                 ANIMATABLE             = (1 << 1),
69
70                 SVM_INTERNAL           = (1 << 2),
71                 OSL_INTERNAL           = (1 << 3),
72                 INTERNAL               = (1 << 2) | (1 << 3),
73
74                 LINK_TEXTURE_GENERATED = (1 << 4),
75                 LINK_TEXTURE_UV        = (1 << 5),
76                 LINK_INCOMING          = (1 << 6),
77                 LINK_NORMAL            = (1 << 7),
78                 LINK_POSITION          = (1 << 8),
79                 LINK_TANGENT           = (1 << 9),
80                 DEFAULT_LINK_MASK      = (1 << 4) | (1 << 5) | (1 << 6) | (1 << 7) | (1 << 8) | (1 << 9)
81         };
82
83         ustring name;
84         Type type;
85         int struct_offset;
86         const void *default_value;
87         const NodeEnum *enum_values;
88         const NodeType **node_type;
89         int flags;
90         ustring ui_name;
91
92         size_t size() const;
93         bool is_array() const;
94         static size_t size(Type type);
95         static size_t max_size();
96         static ustring type_name(Type type);
97         static void *zero_default_value();
98         static bool is_float3(Type type);
99 };
100
101 /* Node Type */
102
103 struct NodeType
104 {
105         enum Type {
106                 NONE,
107                 SHADER
108         };
109
110         explicit NodeType(Type type = NONE);
111         ~NodeType();
112
113         void register_input(ustring name, ustring ui_name, SocketType::Type type,
114                             int struct_offset, const void *default_value,
115                                                 const NodeEnum *enum_values = NULL,
116                                                 const NodeType **node_type = NULL,
117                                                 int flags = 0, int extra_flags = 0);
118         void register_output(ustring name, ustring ui_name, SocketType::Type type);
119
120         const SocketType *find_input(ustring name) const;
121         const SocketType *find_output(ustring name) const;
122
123         typedef Node *(*CreateFunc)(const NodeType *type);
124
125         ustring name;
126         Type type;
127         std::vector<SocketType> inputs;
128         std::vector<SocketType> outputs;
129         CreateFunc create;
130
131         static NodeType *add(const char *name, CreateFunc create, Type type = NONE);
132         static const NodeType *find(ustring name);
133         static unordered_map<ustring, NodeType, ustringHash>& types();
134 };
135
136 /* Node Definition Macros */
137
138 #define NODE_DECLARE                       \
139 template<typename T>                       \
140 static const NodeType *register_type();    \
141 static Node *create(const NodeType *type); \
142 static const NodeType *node_type;
143
144 #define NODE_DEFINE(structname)                                                  \
145 const NodeType *structname::node_type = structname::register_type<structname>(); \
146 Node *structname::create(const NodeType*) { return new structname(); }           \
147 template<typename T>                                                             \
148 const NodeType *structname::register_type()
149
150 /* Sock Definition Macros */
151
152 #define SOCKET_OFFSETOF(T, name) (((char *)&(((T *)1)->name)) - (char *)1)
153 #define SOCKET_SIZEOF(T, name) (sizeof(((T *)1)->name))
154 #define SOCKET_DEFINE(name, ui_name, default_value, datatype, TYPE, flags, ...) \
155         { \
156                 static datatype defval = default_value; \
157                 assert(SOCKET_SIZEOF(T, name) == sizeof(datatype)); \
158                 type->register_input(ustring(#name), ustring(ui_name), TYPE, SOCKET_OFFSETOF(T, name), &defval, NULL, NULL, flags, ##__VA_ARGS__); \
159         }
160
161 #define SOCKET_BOOLEAN(name, ui_name, default_value, ...) \
162         SOCKET_DEFINE(name, ui_name, default_value, bool, SocketType::BOOLEAN, 0, ##__VA_ARGS__)
163 #define SOCKET_INT(name, ui_name, default_value, ...) \
164         SOCKET_DEFINE(name, ui_name, default_value, int, SocketType::INT, 0, ##__VA_ARGS__)
165 #define SOCKET_FLOAT(name, ui_name, default_value, ...) \
166         SOCKET_DEFINE(name, ui_name, default_value, float, SocketType::FLOAT, 0, ##__VA_ARGS__)
167 #define SOCKET_COLOR(name, ui_name, default_value, ...) \
168         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::COLOR, 0, ##__VA_ARGS__)
169 #define SOCKET_VECTOR(name, ui_name, default_value, ...) \
170         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::VECTOR, 0, ##__VA_ARGS__)
171 #define SOCKET_POINT(name, ui_name, default_value, ...) \
172         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::POINT, 0, ##__VA_ARGS__)
173 #define SOCKET_NORMAL(name, ui_name, default_value, ...) \
174         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::NORMAL, 0, ##__VA_ARGS__)
175 #define SOCKET_POINT2(name, ui_name, default_value, ...) \
176         SOCKET_DEFINE(name, ui_name, default_value, float2, SocketType::POINT2, 0, ##__VA_ARGS__)
177 #define SOCKET_STRING(name, ui_name, default_value, ...) \
178         SOCKET_DEFINE(name, ui_name, default_value, ustring, SocketType::STRING, 0, ##__VA_ARGS__)
179 #define SOCKET_TRANSFORM(name, ui_name, default_value, ...) \
180         SOCKET_DEFINE(name, ui_name, default_value, Transform, SocketType::TRANSFORM, 0, ##__VA_ARGS__)
181 #define SOCKET_ENUM(name, ui_name, values, default_value, ...) \
182         { \
183                 static int defval = default_value; \
184                 assert(SOCKET_SIZEOF(T, name) == sizeof(int)); \
185                 type->register_input(ustring(#name), ustring(ui_name), SocketType::ENUM, SOCKET_OFFSETOF(T, name), &defval, &values, NULL, ##__VA_ARGS__); \
186         }
187 #define SOCKET_NODE(name, ui_name, node_type, ...) \
188         { \
189             static Node *defval = NULL; \
190                 assert(SOCKET_SIZEOF(T, name) == sizeof(Node*)); \
191                 type->register_input(ustring(#name), ustring(ui_name), SocketType::NODE, SOCKET_OFFSETOF(T, name), &defval, NULL, node_type, ##__VA_ARGS__); \
192         }
193
194 #define SOCKET_BOOLEAN_ARRAY(name, ui_name, default_value, ...) \
195         SOCKET_DEFINE(name, ui_name, default_value, array<bool>, SocketType::BOOLEAN_ARRAY, 0, ##__VA_ARGS__)
196 #define SOCKET_INT_ARRAY(name, ui_name, default_value, ...) \
197         SOCKET_DEFINE(name, ui_name, default_value, array<int>, SocketType::INT_ARRAY, 0, ##__VA_ARGS__)
198 #define SOCKET_FLOAT_ARRAY(name, ui_name, default_value, ...) \
199         SOCKET_DEFINE(name, ui_name, default_value, array<float>, SocketType::FLOAT_ARRAY, 0, ##__VA_ARGS__)
200 #define SOCKET_COLOR_ARRAY(name, ui_name, default_value, ...) \
201         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::COLOR_ARRAY, 0, ##__VA_ARGS__)
202 #define SOCKET_VECTOR_ARRAY(name, ui_name, default_value, ...) \
203         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::VECTOR_ARRAY, 0, ##__VA_ARGS__)
204 #define SOCKET_POINT_ARRAY(name, ui_name, default_value, ...) \
205         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::POINT_ARRAY, 0, ##__VA_ARGS__)
206 #define SOCKET_NORMAL_ARRAY(name, ui_name, default_value, ...) \
207         SOCKET_DEFINE(name, ui_name, default_value, array<float3>, SocketType::NORMAL_ARRAY, 0, ##__VA_ARGS__)
208 #define SOCKET_POINT2_ARRAY(name, ui_name, default_value, ...) \
209         SOCKET_DEFINE(name, ui_name, default_value, array<float2>, SocketType::POINT2_ARRAY, 0, ##__VA_ARGS__)
210 #define SOCKET_STRING_ARRAY(name, ui_name, default_value, ...) \
211         SOCKET_DEFINE(name, ui_name, default_value, array<ustring>, SocketType::STRING_ARRAY, 0, ##__VA_ARGS__)
212 #define SOCKET_TRANSFORM_ARRAY(name, ui_name, default_value, ...) \
213         SOCKET_DEFINE(name, ui_name, default_value, array<Transform>, SocketType::TRANSFORM_ARRAY, 0, ##__VA_ARGS__)
214 #define SOCKET_NODE_ARRAY(name, ui_name, node_type, ...) \
215         { \
216             static Node *defval = NULL; \
217                 assert(SOCKET_SIZEOF(T, name) == sizeof(Node*)); \
218                 type->register_input(ustring(#name), ustring(ui_name), SocketType::NODE_ARRAY, SOCKET_OFFSETOF(T, name), &defval, NULL, node_type, ##__VA_ARGS__); \
219         }
220
221 #define SOCKET_IN_BOOLEAN(name, ui_name, default_value, ...) \
222         SOCKET_DEFINE(name, ui_name, default_value, bool, SocketType::BOOLEAN, SocketType::LINKABLE, ##__VA_ARGS__)
223 #define SOCKET_IN_INT(name, ui_name, default_value, ...) \
224         SOCKET_DEFINE(name, ui_name, default_value, int, SocketType::INT, SocketType::LINKABLE, ##__VA_ARGS__)
225 #define SOCKET_IN_FLOAT(name, ui_name, default_value, ...) \
226         SOCKET_DEFINE(name, ui_name, default_value, float, SocketType::FLOAT, SocketType::LINKABLE, ##__VA_ARGS__)
227 #define SOCKET_IN_COLOR(name, ui_name, default_value, ...) \
228         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::COLOR, SocketType::LINKABLE, ##__VA_ARGS__)
229 #define SOCKET_IN_VECTOR(name, ui_name, default_value, ...) \
230         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::VECTOR, SocketType::LINKABLE, ##__VA_ARGS__)
231 #define SOCKET_IN_POINT(name, ui_name, default_value, ...) \
232         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::POINT, SocketType::LINKABLE, ##__VA_ARGS__)
233 #define SOCKET_IN_NORMAL(name, ui_name, default_value, ...) \
234         SOCKET_DEFINE(name, ui_name, default_value, float3, SocketType::NORMAL, SocketType::LINKABLE, ##__VA_ARGS__)
235 #define SOCKET_IN_STRING(name, ui_name, default_value, ...) \
236         SOCKET_DEFINE(name, ui_name, default_value, ustring, SocketType::STRING, SocketType::LINKABLE, ##__VA_ARGS__)
237 #define SOCKET_IN_CLOSURE(name, ui_name, ...) \
238         type->register_input(ustring(#name), ustring(ui_name), SocketType::CLOSURE, 0, NULL, NULL, NULL, SocketType::LINKABLE, ##__VA_ARGS__)
239
240 #define SOCKET_OUT_BOOLEAN(name, ui_name) \
241         { type->register_output(ustring(#name), ustring(ui_name), SocketType::BOOLEAN); }
242 #define SOCKET_OUT_INT(name, ui_name) \
243         { type->register_output(ustring(#name), ustring(ui_name), SocketType::INT); }
244 #define SOCKET_OUT_FLOAT(name, ui_name) \
245         { type->register_output(ustring(#name), ustring(ui_name), SocketType::FLOAT); }
246 #define SOCKET_OUT_COLOR(name, ui_name) \
247         { type->register_output(ustring(#name), ustring(ui_name), SocketType::COLOR); }
248 #define SOCKET_OUT_VECTOR(name, ui_name) \
249         { type->register_output(ustring(#name), ustring(ui_name), SocketType::VECTOR); }
250 #define SOCKET_OUT_POINT(name, ui_name) \
251         { type->register_output(ustring(#name), ustring(ui_name), SocketType::POINT); }
252 #define SOCKET_OUT_NORMAL(name, ui_name) \
253         { type->register_output(ustring(#name), ustring(ui_name), SocketType::NORMAL); }
254 #define SOCKET_OUT_CLOSURE(name, ui_name) \
255         { type->register_output(ustring(#name), ustring(ui_name), SocketType::CLOSURE); }
256 #define SOCKET_OUT_STRING(name, ui_name) \
257         { type->register_output(ustring(#name), ustring(ui_name), SocketType::STRING); }
258 #define SOCKET_OUT_ENUM(name, ui_name) \
259         { type->register_output(ustring(#name), ustring(ui_name), SocketType::ENUM); }
260
261 CCL_NAMESPACE_END
262