1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
/*
* Copyright 2011, Blender Foundation.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* Contributor:
* Jeroen Bakker
* Monique Dewanchand
*/
#ifndef _COM_Socket_h
#define _COM_Socket_h
#include <vector>
#include "BKE_text.h"
#include <string>
#include "DNA_node_types.h"
#include "COM_defines.h"
using namespace std;
class SocketConnection;
class NodeBase;
/**
* @brief Base class for InputSocket and OutputSocket.
*
* A socket are the points on an node where the user can make a connection between.
* Sockets are always part of a node or an operation.
*
* @see InputSocket
* @see OutputSocket
* @see SocketConnection - a connection between an InputSocket and an OutputSocket
* @ingroup Model
*/
class Socket {
private:
/**
* Reference to the node where this Socket belongs to
*/
NodeBase* node;
/**
* the datatype of this socket. Is used for automatically data transformation.
* @section data-conversion
*/
DataType datatype;
/**
* the actual data type during execution. This can be different than the field datatype, based on the conversion rules of the node
* @section data-conversion
*/
DataType actualType;
bNodeSocket* editorSocket;
public:
Socket(DataType datatype);
DataType getDataType() const;
void setNode(NodeBase* node);
NodeBase* getNode() const;
/**
* @brief get the actual data type
*
* @note The actual data type can differ from the data type this socket expects.
* @return actual DataType
*/
DataType getActualDataType() const;
/**
* @brief set the actual data type
* @param actualType the new actual type
*/
void setActualDataType(DataType actualType);
const virtual int isConnected() const;
int isInputSocket() const;
int isOutputSocket() const;
virtual void determineResolution(int resolution[], unsigned int preferredResolution[]) {}
virtual void determineActualDataType() {}
void setEditorSocket(bNodeSocket* editorSocket) {this->editorSocket = editorSocket;}
bNodeSocket* getbNodeSocket() const {return this->editorSocket;}
};
#endif
|
