diff options
Diffstat (limited to 'source/blender/compositor/intern/COM_ExecutionSystemHelper.h')
| -rw-r--r-- | source/blender/compositor/intern/COM_ExecutionSystemHelper.h | 144 |
1 files changed, 72 insertions, 72 deletions
diff --git a/source/blender/compositor/intern/COM_ExecutionSystemHelper.h b/source/blender/compositor/intern/COM_ExecutionSystemHelper.h index a72e269115e..99a05472075 100644 --- a/source/blender/compositor/intern/COM_ExecutionSystemHelper.h +++ b/source/blender/compositor/intern/COM_ExecutionSystemHelper.h @@ -42,86 +42,86 @@ class ExecutionSystemHelper { public: /** - * @brief add an bNodeTree to the nodes list and connections - * @param system Execution system - * @param nodes_start Starting index in the system's nodes list for nodes in this tree. - * @param tree bNodeTree to add - * @return Node representing the "Compositor node" of the maintree. or NULL when a subtree is added - */ - static Node *addbNodeTree(ExecutionSystem &system, int nodes_start, bNodeTree * tree); - + * @brief add an bNodeTree to the nodes list and connections + * @param system Execution system + * @param nodes_start Starting index in the system's nodes list for nodes in this tree. + * @param tree bNodeTree to add + * @return Node representing the "Compositor node" of the maintree. or NULL when a subtree is added + */ + static Node *addbNodeTree(ExecutionSystem &system, int nodes_start, bNodeTree *tree, bNode *groupnode); + /** - * @brief add an editor node to the system. - * this node is converted to a Node instance. - * and the converted node is returned - * - * @param bNode node to add - * @return Node that represents the bNode or null when not able to convert. - */ - static Node *addNode(vector<Node*>& nodes, bNode *bNode); - + * @brief add an editor node to the system. + * this node is converted to a Node instance. + * and the converted node is returned + * + * @param bNode node to add + * @return Node that represents the bNode or null when not able to convert. + */ + static Node *addNode(vector<Node *>& nodes, bNode *bNode, bool isInActiveGroup); + /** - * @brief Add a Node to a list - * - * @param nodes the list where the node needs to be added to - * @param node the node to be added - */ - static void addNode(vector<Node*>& nodes, Node *node); - + * @brief Add a Node to a list + * + * @param nodes the list where the node needs to be added to + * @param node the node to be added + */ + static void addNode(vector<Node *>& nodes, Node *node); + /** - * @brief Add an operation to the operation list - * - * The id of the operation is updated. - * - * @param operations the list where the operation need to be added to - * @param operation the operation to add - */ - static void addOperation(vector<NodeOperation*> &operations, NodeOperation *operation); - + * @brief Add an operation to the operation list + * + * The id of the operation is updated. + * + * @param operations the list where the operation need to be added to + * @param operation the operation to add + */ + static void addOperation(vector<NodeOperation *> &operations, NodeOperation *operation); + /** - * @brief Add an ExecutionGroup to a list - * - * The id of the ExecutionGroup is updated. - * - * @param executionGroups the list where the executionGroup need to be added to - * @param executionGroup the ExecutionGroup to add - */ - static void addExecutionGroup(vector<ExecutionGroup*>& executionGroups, ExecutionGroup *executionGroup); - + * @brief Add an ExecutionGroup to a list + * + * The id of the ExecutionGroup is updated. + * + * @param executionGroups the list where the executionGroup need to be added to + * @param executionGroup the ExecutionGroup to add + */ + static void addExecutionGroup(vector<ExecutionGroup *>& executionGroups, ExecutionGroup *executionGroup); + /** - * Find all Node Operations that needs to be executed. - * @param rendering - * the rendering parameter will tell what type of execution we are doing - * FALSE is editing, TRUE is rendering - */ - static void findOutputNodeOperations(vector<NodeOperation*>* result, vector<NodeOperation*>& operations , bool rendering); - + * Find all Node Operations that needs to be executed. + * @param rendering + * the rendering parameter will tell what type of execution we are doing + * FALSE is editing, TRUE is rendering + */ + static void findOutputNodeOperations(vector<NodeOperation *> *result, vector<NodeOperation *>& operations, bool rendering); + /** - * @brief add a bNodeLink to the list of links - * the bNodeLink will be wrapped in a SocketConnection - * - * @note Cyclic links will be ignored - * - * @param node_range list of possible nodes for lookup. - * @param links list of links to add the bNodeLink to - * @param bNodeLink the link to be added - * @return the created SocketConnection or NULL - */ - static SocketConnection *addNodeLink(NodeRange &node_range, vector<SocketConnection*>& links, bNodeLink *bNodeLink); - + * @brief add a bNodeLink to the list of links + * the bNodeLink will be wrapped in a SocketConnection + * + * @note Cyclic links will be ignored + * + * @param node_range list of possible nodes for lookup. + * @param links list of links to add the bNodeLink to + * @param bNodeLink the link to be added + * @return the created SocketConnection or NULL + */ + static SocketConnection *addNodeLink(NodeRange &node_range, vector<SocketConnection *>& links, bNodeLink *bNodeLink); + /** - * @brief create a new SocketConnection and add to a vector of links - * @param links the vector of links - * @param fromSocket the startpoint of the connection - * @param toSocket the endpoint of the connection - * @return the new created SocketConnection - */ - static SocketConnection *addLink(vector<SocketConnection*>& links, OutputSocket *fromSocket, InputSocket *toSocket); - + * @brief create a new SocketConnection and add to a vector of links + * @param links the vector of links + * @param fromSocket the startpoint of the connection + * @param toSocket the endpoint of the connection + * @return the new created SocketConnection + */ + static SocketConnection *addLink(vector<SocketConnection *>& links, OutputSocket *fromSocket, InputSocket *toSocket); + /** - * @brief dumps the content of the execution system to standard out - * @param system the execution system to dump - */ + * @brief dumps the content of the execution system to standard out + * @param system the execution system to dump + */ static void debugDump(ExecutionSystem *system); }; #endif |