Cleanup: Improve comments
[blender.git] / source / blender / nodes / NOD_socket.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2007 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup nodes
22  */
23
24 #pragma once
25
26 #include "DNA_listBase.h"
27
28 #include "BLI_utildefines.h"
29
30 #include "BKE_node.h"
31
32 #include "RNA_types.h"
33
34 struct bNode;
35 struct bNodeTree;
36
37 #ifdef __cplusplus
38 extern "C" {
39 #endif
40
41 struct bNodeSocket *node_add_socket_from_template(struct bNodeTree *ntree,
42                                                   struct bNode *node,
43                                                   struct bNodeSocketTemplate *stemp,
44                                                   eNodeSocketInOut in_out);
45
46 void node_verify_socket_templates(struct bNodeTree *ntree, struct bNode *node);
47
48 void node_socket_init_default_value(struct bNodeSocket *sock);
49 void node_socket_copy_default_value(struct bNodeSocket *to, const struct bNodeSocket *from);
50 void node_socket_skip_reroutes(struct ListBase *links,
51                                struct bNode *node,
52                                struct bNodeSocket *socket,
53                                struct bNode **r_node,
54                                struct bNodeSocket **r_socket);
55 void register_standard_node_socket_types(void);
56
57 #ifdef __cplusplus
58 }
59 #endif