UNI_Manager Class Reference

#include <UNI_Manager.h>

Inheritance diagram for UNI_Manager:

Classes
class	CategoryIterator
	Iterator for traversing loaded categories. More...
class	Event
	Class containing info about magager's change event. More...

Public Types
using	CategoryMap = UT_StringMap< UT_UniquePtr< UNI_Category >>
	Cata structure used for internal mapping of categories. More...
using	CategoryFactory = UT_Function< UNI_CategoryHandle()>
	A factory function that creates and returns a new category. More...
using	CategoryRange = UT_IteratorRange< CategoryIterator >
	Returns a range for iterating loaded categories. More...

Public Member Functions
UT_StringArray	categoryNames (bool include_not_loaded=true) const
void	addCategoryFactory (const UT_StringRef &category_name, const CategoryFactory &factory)
bool	hasCategoryFactory (const UT_StringRef &category_name)
CategoryRange	loadedCategoryRange ()
UT_NotifierImpl< const Event & > &	getEventNotifier ()
void	addRootType (const UT_StringHolder &type_name, const UT_StringArray &child_category_names)
	UNI_Manager ()
	Constructor and destructor. More...
	~UNI_Manager ()
	Constructor and destructor. More...
const UNI_Category *	findCategory (const UT_StringRef &category_name) const
	Returns a node category by the given name, or null if not found. More...
UNI_Category *	findCategory (const UT_StringRef &category_name)
	Returns a node category by the given name, or null if not found. More...

Static Public Member Functions
static UNI_Manager &	get ()

Additional Inherited Members
Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
	UT_NonCopyable ()=default
	~UT_NonCopyable ()=default
	UT_NonCopyable (const UT_NonCopyable &)=delete
UT_NonCopyable &	operator= (const UT_NonCopyable &)=delete

Detailed Description

The manager of UNI graphs. It is a point of entry into the UNI framework.

It provides information about known categories (ie, goups of node types that work together in a domain-specific specialization context of a UNI graph). It also provides the list of existing UNI graphs in the session.

Definition at line 35 of file UNI_Manager.h.

Member Typedef Documentation

using UNI_Manager::CategoryFactory = UT_Function<UNI_CategoryHandle()>

A factory function that creates and returns a new category.

Definition at line 60 of file UNI_Manager.h.

using UNI_Manager::CategoryMap = UT_StringMap< UT_UniquePtr< UNI_Category >>

Cata structure used for internal mapping of categories.

Definition at line 39 of file UNI_Manager.h.

using UNI_Manager::CategoryRange = UT_IteratorRange< CategoryIterator >

Returns a range for iterating loaded categories.

Definition at line 115 of file UNI_Manager.h.

Constructor & Destructor Documentation

UNI_Manager::UNI_Manager

(

)

Constructor and destructor.

UNI_Manager::~UNI_Manager

(

)

Constructor and destructor.

Member Function Documentation

void UNI_Manager::addCategoryFactory	(	const UT_StringRef &	category_name,
		const CategoryFactory &	factory
	)

Registers a new category factory function that returns a newly created category by the given name.

void UNI_Manager::addRootType	(	const UT_StringHolder &	type_name,
		const UT_StringArray &	child_category_names
	)

Adds a node type to our special "root node types" category. This is a category for all the "root" nodes of UNI_Graphs.

UT_StringArray UNI_Manager::categoryNames

(

bool

include_not_loaded = true

)

const

Returns the names of the categorires the manager knows about. include_non_loaded If true the returned result includes

const UNI_Category* UNI_Manager::findCategory ( const UT_StringRef &  category_name ) const

inline

Returns a node category by the given name, or null if not found.

Definition at line 73 of file UNI_Manager.h.

UNI_Category* UNI_Manager::findCategory ( const UT_StringRef &  category_name )

inline

Returns a node category by the given name, or null if not found.

Definition at line 79 of file UNI_Manager.h.

static UNI_Manager& UNI_Manager::get ( )

static

Returns the reference to the global UNI manager, which is accessible in a single Houdini session.

UT_NotifierImpl<const Event &>& UNI_Manager::getEventNotifier ( )

inline

Returns an object used for notifying interested parties about changes to the known categories (adding a new or removing old one).

Definition at line 160 of file UNI_Manager.h.

bool UNI_Manager::hasCategoryFactory

(

const UT_StringRef &

category_name

)

Returns true if the manager has a factory function for the category by the given name.

CategoryRange UNI_Manager::loadedCategoryRange ( )

inline

Definition at line 116 of file UNI_Manager.h.

---

The documentation for this class was generated from the following file:

• UNI/UNI_Manager.h