UN_GraphUtils Namespace Reference

Typedefs
using	TopNodeIterator = UN_NodeUtils::ChildNodeIterator
	An iterator and a range for iterating over the IDs of graph's top nodes. More...
using	TopNodeRange = UT_IteratorRange< TopNodeIterator >
using	AllNodeIterator = UN_NodeUtils::DescendantNodeIterator
	A range for traversing the all the nodes in the given graph. More...
using	AllNodeRange = UT_IteratorRange< AllNodeIterator >
using	TopWireIterator = UN_NodeUtils::ChildWireIterator
using	TopWireRange = UT_IteratorRange< TopWireIterator >
using	AllWireIterator = UN_NodeUtils::DescendantWireIterator
using	AllWireRange = UT_IteratorRange< AllWireIterator >

Functions
UN_API UN_OptionsPtr	asOptions (const UN_GraphData *graph_data)
UN_API void	setFromOptions (UN_GraphData *graph_data, const UN_Options &graph_opts)
	Load and set the graph based on the given options. More...

Typedef Documentation

using UN_GraphUtils::AllNodeIterator = typedef UN_NodeUtils::DescendantNodeIterator

A range for traversing the all the nodes in the given graph.

Definition at line 123 of file UN_GraphUtils.h.

using UN_GraphUtils::AllNodeRange = typedef UT_IteratorRange< AllNodeIterator >

Definition at line 124 of file UN_GraphUtils.h.

using UN_GraphUtils::AllWireIterator = typedef UN_NodeUtils::DescendantWireIterator

An range for traversing the wires between all nodes (top level or deeply nested) inside the graph.

Definition at line 157 of file UN_GraphUtils.h.

using UN_GraphUtils::AllWireRange = typedef UT_IteratorRange< AllWireIterator >

Definition at line 158 of file UN_GraphUtils.h.

using UN_GraphUtils::TopNodeIterator = typedef UN_NodeUtils::ChildNodeIterator

An iterator and a range for iterating over the IDs of graph's top nodes.

Definition at line 102 of file UN_GraphUtils.h.

using UN_GraphUtils::TopNodeRange = typedef UT_IteratorRange< TopNodeIterator >

Definition at line 103 of file UN_GraphUtils.h.

using UN_GraphUtils::TopWireIterator = typedef UN_NodeUtils::ChildWireIterator

A range for traversing the top level wires contained directly inside the graph.

Definition at line 144 of file UN_GraphUtils.h.

using UN_GraphUtils::TopWireRange = typedef UT_IteratorRange< TopWireIterator >

Definition at line 145 of file UN_GraphUtils.h.

Function Documentation

UN_API UN_OptionsPtr UN_GraphUtils::asOptions

(

const UN_GraphData *

graph_data

)

Returns the options object representing this graph. This can be then used for serialization to JSON, etc.

UN_API void UN_GraphUtils::setFromOptions	(	UN_GraphData *	graph_data,
		const UN_Options &	graph_opts
	)

Load and set the graph based on the given options.