Classes
class	Broker
	Intermediate object between the Usd Stage and any clients that needs asynchronous handling and upstream filtering of notices. More...

class	CapturePredicate
	Predicate functor which indicates whether a notice can be captured during a transaction. More...

class	Dispatcher
	Interface for objects emitting standalone notices triggered by incoming PXR_NS::TfNotice derived notices. More...

class	StageDispatcher
	Default dispatcher which emits UnfNotice::StageNotice derived notices corresponding to each PXR_NS::UsdNotice::StageNotice derived notice received. More...

class	DispatcherFactory
	Interface for building Dispatcher type. More...

class	DispatcherFactoryImpl
	Templated factory class which creates a specific type of Dispatcher. More...

class	NoticeTransaction
	Convenient RAII object to consolidate and filter notices derived from UnfNotice::StageNotice within a specific scope. More...

Typedefs
using	BrokerPtr = PXR_NS::TfRefPtr< Broker >
	Convenient alias for Broker reference pointer.

using	BrokerWeakPtr = PXR_NS::TfWeakPtr< Broker >
	Convenient alias for Broker weak pointer.

using	DispatcherPtr = PXR_NS::TfRefPtr< Dispatcher >
	Convenient alias for Dispatcher reference pointer.

using	CapturePredicateFunc = std::function< bool(const UnfNotice::StageNotice &)>
	Convenient alias for function defining whether notice can be captured.

using	TfTokenSet = std::unordered_set< PXR_NS::TfToken, PXR_NS::TfToken::HashFunctor >
	Convenient alias for set of tokens.

using	SdfPathSet = std::unordered_set< PXR_NS::SdfPath, PXR_NS::SdfPath::Hash >
	Convenient alias for set of paths.

using	ChangedFieldMap = std::unordered_map< PXR_NS::SdfPath, TfTokenSet, PXR_NS::SdfPath::Hash >
	Convenient alias for map of token sets organized per path.

Functions
template<class T , class... Bases>
void	DispatcherDefine ()
	Define a PXR_NS::TfType for a specific type of Dispatcher. More...

Detailed Description

Scope of the Usd Notice Framework library.

Function Documentation

template<class T , class... Bases>

unf::DispatcherDefine ( )

Define a PXR_NS::TfType for a specific type of Dispatcher.

Typical usage to define a type for a dispatcher Foo would be:

TF_REGISTRY_FUNCTION(PXR_NS::TfType)
{
    DispatcherDefine<Foo, Dispatcher>();
}