optionally use guarded alloc for tiles compositor, also replace allocation functions...
[blender.git] / source / blender / compositor / intern / COM_Converter.h
1 /*
2  * Copyright 2011, Blender Foundation.
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  * Contributor: 
19  *              Jeroen Bakker 
20  *              Monique Dewanchand
21  */
22
23 #ifndef _COM_Converter_h
24 #define _COM_Converter_h
25
26 #include "DNA_node_types.h"
27 #include "COM_Node.h"
28
29 /**
30  * @brief Conversion methods for the compositor
31  */
32 class Converter {
33 public:
34         /**
35          * @brief Convert/wraps a bNode in its Node instance.
36          *
37          * For all nodetypes a wrapper class is created.
38          * Muted nodes are wrapped with MuteNode.
39          *
40          * @note When adding a new node to blender, this method needs to be changed to return the correct Node instance.
41          *
42          * @see Node
43          * @see MuteNode
44          */
45         static Node *convert(bNode *bNode);
46         
47         /**
48          * @brief This method will add a datetype conversion rule when the to-socket does not support the from-socket actual data type.
49          *
50          * @note this method is called when conversion is needed.
51          *
52          * @param connection the SocketConnection what needs conversion
53          * @param system the ExecutionSystem to add the conversion to.
54          * @see SocketConnection - a link between two sockets
55          */
56         static void convertDataType(SocketConnection *connection, ExecutionSystem *system);
57         
58         /**
59          * @brief This method will add a resolution rule based on the settings of the InputSocket.
60          *
61          * @note Conversion logic is implemented in this method
62          * @see InputSocketResizeMode for the possible conversions.
63
64          * @param connection the SocketConnection what needs conversion
65          * @param system the ExecutionSystem to add the conversion to.
66          * @see SocketConnection - a link between two sockets
67          */
68         static void convertResolution(SocketConnection *connection, ExecutionSystem *system);
69
70 #ifdef WITH_CXX_GUARDEDALLOC
71         MEM_CXX_CLASS_ALLOC_FUNCS("COM:Converter")
72 #endif
73 };
74 #endif