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