|
| using | ParmIterator = UN_HandleIterator< PARM, GRAPH_DATA, UN_NodeUtils::ParmIterator > |
| | An iterator and a range for parameters that belong to this node. More...
|
| |
| using | ParmRange = UT_IteratorRange< ParmIterator > |
| |
| using | PortIterator = UN_HandleIterator< PORT, GRAPH_DATA, UN_NodeUtils::PortIterator > |
| | And iterator and a range for ports that belong to this node. More...
|
| |
| using | PortRange = UT_IteratorRange< PortIterator > |
| |
| using | PortReverseIterator = UN_HandleIterator< PORT, GRAPH_DATA, UN_NodeUtils::PortReverseIterator > |
| | And iterator and a range for ports that belong to this node. More...
|
| |
| using | PortReverseRange = UT_IteratorRange< PortReverseIterator > |
| |
| using | ChildNodeIterator = UN_HandleIterator< NODE, GRAPH_DATA, UN_NodeUtils::ChildNodeIterator > |
| | An iterator and a range for the children of this parent node. More...
|
| |
| using | ChildNodeRange = UT_IteratorRange< ChildNodeIterator > |
| |
| using | DescendantNodeIterator = UN_HandleIterator< NODE, GRAPH_DATA, UN_NodeUtils::DescendantNodeIterator > |
| |
| using | DescendantNodeRange = UT_IteratorRange< DescendantNodeIterator > |
| |
| using | ChildWireIterator = UN_HandleIterator< WIRE, GRAPH_DATA, UN_NodeUtils::ChildWireIterator > |
| |
| using | ChildWireRange = UT_IteratorRange< ChildWireIterator > |
| |
| using | DescendantWireIterator = UN_HandleIterator< WIRE, GRAPH_DATA, UN_NodeUtils::DescendantWireIterator > |
| |
| using | DescendantWireRange = UT_IteratorRange< DescendantWireIterator > |
| |
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
class UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >
Base class template for the UN node handle. Its main purpose is to factor common code for const and non-const handles.
Definition at line 41 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
An iterator and a range for the connection wires between immediate children inside this node. (And also direct wires between inputs and outputs on this node).
Definition at line 450 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
An iterator and a range for the connection wires between the descendants (children, grandchildren, etc) inside this node. (And also direct wires between inputs and outputs on this node).
Definition at line 478 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::UN_NodeBase |
( |
GRAPH_DATA * |
graph_data, |
|
|
UN_NodeID |
node_id |
|
) |
| |
|
inlineprotected |
Constructs a handle that references the given node in the given graph.
Definition at line 48 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the options object representing this node. This can be then used for serialization to JSON, etc.
Definition at line 511 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the node's category that groups it with other nodes that are operationally compatible (and connectable).
Definition at line 109 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the names of the node children nodes.
Definition at line 372 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over node's immediate children.
Definition at line 410 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UT_Array<NODE> UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::childNodes |
( |
| ) |
const |
|
inline |
Returns the children nodes directly inside this node.
Definition at line 421 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UT_Array<STICKY_NOTE> UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::childStickyNotes |
( |
| ) |
const |
|
inline |
Returns the child sticky notes directly inside this node.
Definition at line 503 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over the connection wires between this node's immediate children, directly inside the this node. (And also direct wires between inputs and outputs on this node).
Definition at line 456 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UT_Array<WIRE> UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::childWires |
( |
| ) |
const |
|
inline |
Returns the wires connecting child nodes directly inside this node (And also direct wires between inputs and outputs on this node).
Definition at line 467 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the node's color.
Definition at line 139 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the comment for the node.
Definition at line 127 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| const UN_GraphData* UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::constGraphData |
( |
| ) |
const |
|
inline |
Returns the owner of the underlying graph data structures.
Definition at line 56 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over the descendant nodes of this (ancestor) node.
Definition at line 436 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over the connection wires between this node's descendants (ie, its children and grandchildren, etc). (And also direct wires between inputs and outputs on this node).
Definition at line 484 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| NODE UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::findChildNode |
( |
const UT_StringRef & |
child_name | ) |
const |
|
inline |
Returns the child node by the given name, or an invalid handle if no such child node was found.
Definition at line 379 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| STICKY_NOTE UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::findChildStickyNote |
( |
const UT_StringRef & |
child_name | ) |
const |
|
inline |
Returns the child sticky note by the given name, or an invalid handle if no such child node was found.
Definition at line 495 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| PORT UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::findInputPort |
( |
const UT_StringRef & |
port_name | ) |
const |
|
inline |
Returns this node's input port by the given name, or an invalid port handle, if no such input was found,
Definition at line 283 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| NODE UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::findNode |
( |
const UT_StringRef & |
node_path | ) |
const |
|
inline |
Returns a node at the given path, or an invalid handle if not found.
node_path - The node path identifying the node to find. This can be either an absolute path (starting with a slash, '/') or a relative path. When the path is relative, this node is used as an anchor from which the relative path is followed to find the desired node. In particular, when the node path is just a name, this function will look for a child by that name directly inside this parent. The path can contain '.' for the current node, and '..' for parent.
Definition at line 396 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| PORT UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::findOutputPort |
( |
const UT_StringRef & |
port_name | ) |
const |
|
inline |
Returns this node's output port by the given name, or an invalid port handle, if no such output was found,
Definition at line 331 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| PARM UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::findParm |
( |
const UT_StringRef & |
parm_name | ) |
const |
|
inline |
Returns a parameter by the given name, or an invalid parm if not found.
Definition at line 170 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns this node's port by the given name, or an invalid port handle, if no such port was found,
Definition at line 213 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a node name that is not taken by any of this nodes' children.
Definition at line 358 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| GRAPH_DATA* UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::graphData |
( |
| ) |
const |
|
inline |
Returns the owner of the underlying graph data structures.
Definition at line 54 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the names of the node input ports.
Definition at line 270 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| PortRange UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::inputPortRange |
( |
| ) |
const |
|
inline |
Returns a range for iterating over node input ports, forward from first to last.
Definition at line 290 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over node input ports, backwards from last to first.
Definition at line 297 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UT_Array<PORT> UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::inputPorts |
( |
| ) |
const |
|
inline |
Returns this node's input ports of the given kind.
Definition at line 303 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the type names of the node input ports.
Definition at line 276 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| bool UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::isAnyInputPortConnectedToSrc |
( |
| ) |
const |
|
inline |
Returns true if any of the node's input ports has a connected source wire (feeding data from a source port).
Definition at line 263 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| bool UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::isAnyOutputPortConnectedToDst |
( |
| ) |
const |
|
inline |
Returns true if any of the node's output ports has a connected destination wire feeding data to a destination port.
Definition at line 311 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| bool UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::isSubnet |
( |
| ) |
const |
|
inline |
Returns true if the node can have child nodes inside.
Definition at line 366 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| bool UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::isValid |
( |
| ) |
const |
|
inline |
Returns true if this node is valid within the graph; false otherwise.
Definition at line 65 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the node's metadata.
Definition at line 151 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the node name that differentiates it among its siblings.
Definition at line 96 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UN_NodeID UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::nodeID |
( |
| ) |
const |
|
inline |
Returns the unique ID of the node this handle refers to.
Definition at line 61 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| NODE UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::nonRootParent |
( |
| ) |
const |
|
inline |
Returns a non-root parent node ID of the given child node. Note, for top-level nodes, this will return an invalid node ID, because their parent is the implicitly created graph's root node.
Definition at line 87 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::operator bool |
( |
| ) |
const |
|
inlineexplicit |
Returns true if this node is valid within the graph; false otherwise.
Definition at line 70 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the names of the node output ports.
Definition at line 318 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| PortRange UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::outputPortRange |
( |
| ) |
const |
|
inline |
Returns a range for iterating over this node's output ports, forward from first to last.
Definition at line 338 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over this node's output ports, backwards from last to first.
Definition at line 345 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UT_Array<PORT> UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::outputPorts |
( |
| ) |
const |
|
inline |
Returns this node's output ports of the given kind.
Definition at line 351 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the type names of the node output ports.
Definition at line 324 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| NODE UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::parent |
( |
| ) |
const |
|
inline |
Returns the parent of this node. Note, for top-level nodes, this will return a graph's root node.
Definition at line 77 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the names of the node parameters.
Definition at line 158 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| ParmRange UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::parmRange |
( |
| ) |
const |
|
inline |
Returns a range for iterating over node parameters.
Definition at line 182 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| UT_Array<PARM> UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::parms |
( |
| ) |
const |
|
inline |
Returns the parameters of this node.
Definition at line 191 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the type names of the node parameters.
Definition at line 164 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over this node's ports of the given kind, forward from first to last.
Definition at line 228 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns a range for iterating over this node's ports of the given kind, backward from last to first.
Definition at line 244 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns this node's ports of the given kind.
Definition at line 254 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the type names of the node ports of a given kind.
Definition at line 205 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
| const UT_Vector2D& UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >::position |
( |
| ) |
const |
|
inline |
Returns the node's position in the node editor.
Definition at line 133 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the signature for the node.
Definition at line 115 of file UN_Node.h.
template<typename BASE_CLASS, typename GRAPH_DATA, typename NODE, typename PARM, typename PORT, typename STICKY_NOTE, typename WIRE>
Returns the node's type that determines its functional behavour.
Definition at line 102 of file UN_Node.h.
Inheritance diagram for UN_NodeBase< BASE_CLASS, GRAPH_DATA, NODE, PARM, PORT, STICKY_NOTE, WIRE >:
1.8.6 
