UN_NodeUtils.h File Reference

#include "UN_API.h"
#include "UN_GraphData.h"

Include dependency graph for UN_NodeUtils.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UN_NodeUtils::DescendantNodeIterator
class	UN_NodeUtils::DescendantWireIterator
	An iterator for traversing the wires deep inside the given node. More...

Namespaces
	UN_NodeUtils

Typedefs
using	UN_NodeUtils::ParmIterator = UN_ParmIDList::const_iterator
using	UN_NodeUtils::ParmRange = UT_IteratorRange< ParmIterator >
using	UN_NodeUtils::PortIterator = UN_PortIDList::const_iterator
	An iterator and a range for iterating over node port IDs. More...
using	UN_NodeUtils::PortRange = UT_IteratorRange< PortIterator >
using	UN_NodeUtils::PortReverseIterator = UN_PortIDList::const_reverse_iterator
using	UN_NodeUtils::PortReverseRange = UT_IteratorRange< PortReverseIterator >
using	UN_NodeUtils::ChildNodeIterator = UN_NodeIDList::const_iterator
	An iterator and a range for iterating over child node IDs. More...
using	UN_NodeUtils::ChildNodeRange = UT_IteratorRange< ChildNodeIterator >
using	UN_NodeUtils::DescendantNodeRange = UT_IteratorRange< DescendantNodeIterator >
	A range for traversing the descendant nodes of a given ancestor node. More...
using	UN_NodeUtils::ChildWireIterator = UN_WireIDList::const_iterator
	A range for traversing the wires contained directly inside a node. More...
using	UN_NodeUtils::ChildWireRange = UT_IteratorRange< ChildWireIterator >
using	UN_NodeUtils::DescendantWireRange = UT_IteratorRange< DescendantWireIterator >

Functions
UN_API UT_StringHolder	UN_NodeUtils::path (const UN_GraphData *graph_data, UN_NodeID node_id)
	Returns the node path. More...
UN_API UN_ParmID	UN_NodeUtils::createParm (UN_GraphData *graph_data, UN_NodeID node_id, const UT_StringRef &parm_name, const UT_StringRef &parm_type_name=UN_UNDEFINED_PARM_TYPE_NAME.asRef())
UN_API UT_Array< UT_StringHolder >	UN_NodeUtils::parmNames (const UN_GraphData *graph_data, UN_NodeID node_id)
	Returns the names of the node parameters. More...
UN_API UT_Array< UT_StringHolder >	UN_NodeUtils::parmTypeNames (const UN_GraphData *graph_data, UN_NodeID node_id)
	Returns the type names of the node parameters. More...
UN_API UN_PortID	UN_NodeUtils::createPort (UN_GraphData *graph_data, UN_NodeID node_id, UN_PortKind port_kind, const UT_StringRef &port_name, const UT_StringRef &port_type_name=UN_UNDEFINED_PORT_TYPE_NAME.asRef(), const UT_StringRef &port_label=UT_StringRef(), const UT_Optional< exint > &index=std::nullopt)
UN_API UT_Array< UT_StringHolder >	UN_NodeUtils::portNames (const UN_GraphData *graph_data, UN_NodeID node_id, UN_PortKind port_kind)
	Returns the names of the node ports of a given kind. More...
UN_API UT_Array< UT_StringHolder >	UN_NodeUtils::portTypeNames (const UN_GraphData *graph_data, UN_NodeID node_id, UN_PortKind port_kind)
	Returns the type names of the node ports of a given kind. More...
UN_API bool	UN_NodeUtils::isAnyInputPortConnectedToSrc (const UN_GraphData *graph_data, UN_NodeID node_id)
UN_API bool	UN_NodeUtils::isAnyOutputPortConnectedToDst (const UN_GraphData *graph_data, UN_NodeID node_id)
UN_API UT_StringHolder	UN_NodeUtils::findValidUniqueChildNodeName (const UN_GraphData *graph_data, UN_NodeID node_id, const UT_StringRef &child_name=UT_StringRef())
UN_API UN_NodeID	UN_NodeUtils::createChildNode (UN_GraphData *graph_data, UN_NodeID parent_id, const UT_StringRef &child_name=UT_StringRef(), const UT_StringRef &child_type=UT_StringRef(), const UT_StringRef &child_category=UT_StringRef())
	Creates and returns a new node that is a child of this node. More...
UN_API void	UN_NodeUtils::deleteChildNode (UN_GraphData *graph_data, UN_NodeID parent_id, const UT_StringRef &child_name)
	Deletes the child node from the graph (removing it from this network). More...
UN_API UT_Array< UT_StringHolder >	UN_NodeUtils::childNodeNames (const UN_GraphData *graph_data, UN_NodeID node_id)
	Returns the names of the children nodes of the given parent node. More...
UN_API UN_WireIDList	UN_NodeUtils::srcWires (const UN_GraphData *graph_data, UN_NodeID node_id, UN_PortKind port_kind)
UN_API UN_WireIDList	UN_NodeUtils::dstWires (const UN_GraphData *graph_data, UN_NodeID node_id, UN_PortKind port_kind)
UN_API UN_StickyNoteID	UN_NodeUtils::createChildStickyNote (UN_GraphData *graph_data, UN_NodeID parent_id, const UT_StringRef &sticky_note_name=UT_StringRef(), const UT_StringRef &sticky_note_text=UT_StringRef())
	Creates and returns a new sticky note that is a child of this node. More...
UN_API void	UN_NodeUtils::deleteChildStickyNote (UN_GraphData *graph_data, UN_NodeID parent_id, const UT_StringRef &child_sticky_note_name)
UN_API UN_OptionsPtr	UN_NodeUtils::asOptions (const UN_GraphData *graph_data, UN_NodeID node_id)
UN_API void	UN_NodeUtils::setFromOptions (UN_GraphData *graph_data, UN_NodeID node_id, const UN_Options &node_opts)
	Load and set the node based on the given options. More...