Make dynamic node labels possible as a registerable function 'draw_label' (simple...
[blender.git] / source / blender / nodes / intern / node_util.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): Nathan Letwory.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/nodes/intern/node_util.h
29  *  \ingroup nodes
30  */
31
32
33 #ifndef __NODE_UTIL_H__
34 #define __NODE_UTIL_H__
35
36 #include "DNA_listBase.h"
37
38 #include "BLI_utildefines.h"
39
40 #include "BKE_node.h"
41
42 #include "MEM_guardedalloc.h"
43
44 #include "NOD_socket.h"
45
46 #include "GPU_material.h" /* For Shader muting GPU code... */
47
48 #include "RNA_access.h"
49
50 struct bNodeTree;
51 struct bNode;
52
53 /* data for initializing node execution */
54 typedef struct bNodeExecContext {
55         struct bNodeInstanceHash *previews;
56 } bNodeExecContext;
57
58 typedef struct bNodeExecData {
59         void *data;                                             /* custom data storage */
60         struct bNodePreview *preview;   /* optional preview image */
61 } bNodeExecData;
62
63 /**** Storage Data ****/
64
65 extern void node_free_curves(struct bNode *node);
66 extern void node_free_standard_storage(struct bNode *node);
67
68 extern void node_copy_curves(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node);
69 extern void node_copy_standard_storage(struct bNodeTree *dest_ntree, struct bNode *dest_node, struct bNode *src_node);
70 extern void *node_initexec_curves(struct bNodeExecContext *context, struct bNode *node, bNodeInstanceKey key);
71
72 /**** Labels ****/
73
74 void node_blend_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
75 void node_math_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
76 void node_vect_math_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
77 void node_filter_label(struct bNodeTree *ntree, struct bNode *node, char *label, int maxlen);
78
79 void node_update_internal_links_default(struct bNodeTree *ntree, struct bNode *node);
80
81 float node_socket_get_float(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock);
82 void node_socket_set_float(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock, float value);
83 void node_socket_get_color(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock, float *value);
84 void node_socket_set_color(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock, const float *value);
85 void node_socket_get_vector(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock, float *value);
86 void node_socket_set_vector(struct bNodeTree *ntree, struct bNode *node, struct bNodeSocket *sock, const float *value);
87
88 #endif