diff options
author | Lukas Tönne <lukas.toenne@gmail.com> | 2014-04-15 18:06:12 +0400 |
---|---|---|
committer | Lukas Tönne <lukas.toenne@gmail.com> | 2014-04-15 18:28:10 +0400 |
commit | 09874df135888b89f51d7becaa369ebb1d1623c6 (patch) | |
tree | bccf5950d42963992adff95dbc3f00ed7db1cf16 /source/blender/compositor/intern/COM_InputSocket.h | |
parent | 28a829893c702918afc5ac1945a06eaefa611594 (diff) |
Structural cleanup and improvements for the compositor.
Many parts of the compositor are unnecessarily complicated. This patch
aims at reducing the complexity of writing nodes and making the code
more transparent.
== Separating Nodes and Operations ==
Currently these are both mixed in the same graph, even though they have
very different purposes and are used at distinct stages in the
compositing process. The patch introduces dedicated graph classes for
nodes and for operations.
This removes the need for a lot of special case checks (isOperation etc.)
and explicit type casts. It simplifies the code since it becomes clear
at every stage what type of node we are dealing with. The compiler can
use static typing to avoid common bugs from mixing up these types and
fewer runtime sanity checks are needed.
== Simplified Node Conversion ==
Converting nodes to operations was previously based on "relinking", i.e.
nodes would start with by mirroring links in the Blender DNA node trees,
then add operations and redirect these links to them. This was very hard
to follow in many cases and required a lot of attention to avoid invalid
states.
Now there is a helper class called the NodeConverter, which is passed to
nodes and implements a much simpler API for this process. Nodes can add
operations and explicit connections as before, but defining "external"
links to the inputs/outputs of the original node now uses mapping
instead of directly modifying link data. Input data (node graph) and
result (operations graph) are cleanly separated.
== Removed Redundant Data Structures ==
A few redundant data structures have been removed, notably the
SocketConnection. These are only needed temporarily during graph
construction. For executing the compositor operations it is perfectly
sufficient to store only the direct input link pointers. A common
pointer indirection is avoided this way (which might also give a little
performance improvement).
== Avoid virtual recursive functions ==
Recursive virtual functions are evil. They are very hard to follow
during debugging. At least in the parts this patch is concerned with
these functions have been replaced by a non-virtual recursive core
function (which might then call virtual non-recursive functions if
needed). See for example NodeOperationBuilder::group_operations.
Diffstat (limited to 'source/blender/compositor/intern/COM_InputSocket.h')
-rw-r--r-- | source/blender/compositor/intern/COM_InputSocket.h | 149 |
1 files changed, 0 insertions, 149 deletions
diff --git a/source/blender/compositor/intern/COM_InputSocket.h b/source/blender/compositor/intern/COM_InputSocket.h deleted file mode 100644 index 23490b66bba..00000000000 --- a/source/blender/compositor/intern/COM_InputSocket.h +++ /dev/null @@ -1,149 +0,0 @@ -/* - * 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_InputSocket_h -#define _COM_InputSocket_h - -#include <vector> -#include "COM_Socket.h" -#include "COM_SocketReader.h" - -using namespace std; -class SocketConnection; -class Node; -class ExecutionSystem; -class OutputSocket; -class ChannelInfo; -class NodeOperation; - -/** - * @brief Resize modes of inputsockets - * How are the input and working resolutions matched - * @ingroup Model - */ -typedef enum InputSocketResizeMode { - /** @brief Center the input image to the center of the working area of the node, no resizing occurs */ - COM_SC_CENTER = NS_CR_CENTER, - /** @brief The bottom left of the input image is the bottom left of the working area of the node, no resizing occurs */ - COM_SC_NO_RESIZE = NS_CR_NONE, - /** @brief Fit the width of the input image to the width of the working area of the node */ - COM_SC_FIT_WIDTH = NS_CR_FIT_WIDTH, - /** @brief Fit the height of the input image to the height of the working area of the node */ - COM_SC_FIT_HEIGHT = NS_CR_FIT_HEIGHT, - /** @brief Fit the width or the height of the input image to the width or height of the working area of the node, image will be larger than the working area */ - COM_SC_FIT = NS_CR_FIT, - /** @brief Fit the width and the height of the input image to the width and height of the working area of the node, image will be equally larger than the working area */ - COM_SC_STRETCH = NS_CR_STRETCH -} InputSocketResizeMode; - -/** - * @brief InputSocket are sockets that can receive data/input - * @ingroup Model - */ -class InputSocket : public Socket { -private: - /** - * @brief connection connected to this InputSocket. - * An input socket can only have a single connection - */ - SocketConnection *m_connection; - - /** - * @brief resize mode of this socket - */ - InputSocketResizeMode m_resizeMode; - - -public: - InputSocket(DataType datatype); - InputSocket(DataType datatype, InputSocketResizeMode resizeMode); - InputSocket(InputSocket *from); - - void setConnection(SocketConnection *connection); - SocketConnection *getConnection(); - - const int isConnected() const; - int isInputSocket() const; - - /** - * @brief determine the resolution of this data going through this socket - * @param resolution the result of this operation - * @param preferredResolution the preferable resolution as no resolution could be determined - */ - void determineResolution(unsigned int resolution[2], unsigned int preferredResolution[2]); - - /** - * @brief move all connections of this input socket to another socket - * only use this method when already checked the availability of a SocketConnection - * @param relinkToSocket the socket to move to connections to - */ - void relinkConnections(InputSocket *relinkToSocket); - - /** - * @brief move all connections of this input socket to another socket - * @param relinkToSocket the socket to move to connections to - * @param editorNodeInputSocketIndex index of the socket number of the bNode (used to retrieve the value for autoconnection) - * @param system ExecutionSystem to update to - */ - void relinkConnections(InputSocket *relinkToSocket, int editorNodeInputSocketIndex, ExecutionSystem *system); - - /** - * @brief add a connection of this input socket to another socket - * @warning make sure to remove the original connection with \a unlinkConnections afterward. - * @param relinkToSocket the socket to move to connections to - * @param editorNodeInputSocketIndex index of the socket number of the bNode (used to retrieve the value for autoconnection) - * @param system ExecutionSystem to update to - */ - void relinkConnectionsDuplicate(InputSocket *relinkToSocket, int editorNodeInputSocketIndex, ExecutionSystem *system); - - /** - * @brief remove all connections of this input socket. - * @warning \a relinkConnectionsDuplicate should be used to ensure this socket is still connected. - * @param system ExecutionSystem to update to - */ - void unlinkConnections(ExecutionSystem *system); - - /** - * @brief set the resize mode - * @param resizeMode the new resize mode. - */ - void setResizeMode(InputSocketResizeMode resizeMode) { - this->m_resizeMode = resizeMode; - } - - /** - * @brief get the resize mode of this socket - * @return InputSocketResizeMode - */ - InputSocketResizeMode getResizeMode() const { - return this->m_resizeMode; - } - - const ChannelInfo *getChannelInfo(const int channelnumber); - - bool isStatic(); - - SocketReader *getReader(); - NodeOperation *getOperation() const; -}; - -#endif |