Cleanup: remove non-existing function declarations
[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 #ifdef WITH_CXX_GUARDEDALLOC
27 #  include "MEM_guardedalloc.h"
28 #endif
29
30 struct bNode;
31
32 class Node;
33 class NodeOperation;
34 class NodeOperationInput;
35 class NodeOperationOutput;
36 class NodeOperationBuilder;
37
38 /**
39  * \brief Conversion methods for the compositor
40  */
41 class Converter {
42 public:
43         /**
44          * \brief Convert/wraps a bNode in its Node instance.
45          *
46          * For all nodetypes a wrapper class is created.
47          *
48          * \note When adding a new node to blender, this method needs to be changed to return the correct Node instance.
49          *
50          * \see Node
51          */
52         static Node *convert(bNode *b_node);
53
54         /**
55          * \brief True if the node is considered 'fast'.
56          *
57          * Slow nodes will be skipped if fast execution is required.
58          */
59         static bool is_fast_node(bNode *b_node);
60
61         /**
62          * \brief This method will add a datetype conversion rule when the to-socket does not support the from-socket actual data type.
63          *
64          * \note this method is called when conversion is needed.
65          *
66          * \param link: the NodeLink what needs conversion
67          * \param system: the ExecutionSystem to add the conversion to.
68          * \see NodeLink - a link between two sockets
69          */
70         static NodeOperation *convertDataType(NodeOperationOutput *from, NodeOperationInput *to);
71
72         /**
73          * \brief This method will add a resolution rule based on the settings of the NodeInput.
74          *
75          * \note Conversion logic is implemented in this method
76          * \see InputSocketResizeMode for the possible conversions.
77          *
78          * \param link: the NodeLink what needs conversion
79          * \param system: the ExecutionSystem to add the conversion to.
80          * \see NodeLink - a link between two sockets
81          */
82         static void convertResolution(NodeOperationBuilder &builder, NodeOperationOutput *fromSocket, NodeOperationInput *toSocket);
83
84 #ifdef WITH_CXX_GUARDEDALLOC
85         MEM_CXX_CLASS_ALLOC_FUNCS("COM:Converter")
86 #endif
87 };
88 #endif