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_SocketConnection.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_SocketConnection.h')
-rw-r--r-- | source/blender/compositor/intern/COM_SocketConnection.h | 127 |
1 files changed, 0 insertions, 127 deletions
diff --git a/source/blender/compositor/intern/COM_SocketConnection.h b/source/blender/compositor/intern/COM_SocketConnection.h deleted file mode 100644 index 9777bd45be2..00000000000 --- a/source/blender/compositor/intern/COM_SocketConnection.h +++ /dev/null @@ -1,127 +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_SocketConnection_h -#define _COM_SocketConnection_h - -#include "DNA_node_types.h" -#include "COM_Node.h" -#include "COM_Socket.h" -#include "COM_ChannelInfo.h" - -/** - * @brief An SocketConnection is an connection between an InputSocket and an OutputSocket. - * - * <pre> - * +----------+ To InputSocket +----------+ - * | From | SocketConnection \| To Node | - * | Node *====================* | - * | |\ | | - * | | From OutputSocket +----------+ - * +----------+ - * </pre> - * @ingroup Model - * @see InputSocket - * @see OutputSocket - */ -class SocketConnection { -private: - /** - * @brief Startpoint of the connection - */ - OutputSocket *m_fromSocket; - - /** - * @brief Endpoint of the connection - */ - InputSocket *m_toSocket; - - /** - * @brief has the resize already been done for this connection - */ - bool m_ignoreResizeCheck; -public: - SocketConnection(); - - /** - * @brief set the startpoint of the connection - * @param fromsocket - */ - void setFromSocket(OutputSocket *fromsocket); - - /** - * @brief get the startpoint of the connection - * @return from OutputSocket - */ - OutputSocket *getFromSocket() const; - - /** - * @brief set the endpoint of the connection - * @param tosocket - */ - void setToSocket(InputSocket *tosocket); - - /** - * @brief get the endpoint of the connection - * @return to InputSocket - */ - InputSocket *getToSocket() const; - - /** - * @brief check if this connection is valid - */ - bool isValid() const; - - /** - * @brief return the Node where this connection is connected from - */ - NodeBase *getFromNode() const; - - /** - * @brief return the Node where this connection is connected to - */ - NodeBase *getToNode() const; - - /** - * @brief set, whether the resize has already been done for this SocketConnection - */ - void setIgnoreResizeCheck(bool check) { this->m_ignoreResizeCheck = check; } - - /** - * @brief has the resize already been done for this SocketConnection - */ - bool isIgnoreResizeCheck() const { return this->m_ignoreResizeCheck; } - - /** - * @brief does this SocketConnection need resolution conversion - * @note PreviewOperation's will be ignored - * @note Already converted SocketConnection's will be ignored - * @return needs conversion [true:false] - */ - bool needsResolutionConversion() const; - -#ifdef WITH_CXX_GUARDEDALLOC - MEM_CXX_CLASS_ALLOC_FUNCS("COM:SocketConnection") -#endif -}; - -#endif |