documented new node classes

This commit is contained in:
itsmattkc
2019-07-17 03:05:25 -04:00
parent 39256fd6f9
commit 9f6d0f9dc7
20 changed files with 435 additions and 7 deletions
+16
View File
@@ -26,12 +26,28 @@
class NodeOutput;
class NodeInput;
/**
* @brief A connection between two node parameters (a NodeOutput and a NodeInput)
*
* To simplify memory management, it's recommended to use NodeEdgePtr instead of raw pointers when working with
* NodeEdge.
*/
class NodeEdge
{
public:
/**
* @brief Create a node edge connecting an output to an input
*/
NodeEdge(NodeOutput* output, NodeInput* input);
/**
* @brief Return the output parameter this edge is connected to
*/
NodeOutput* output();
/**
* @brief Return the input parameter this edge is connected to
*/
NodeInput* input();
private: