#include <primTypeNoticeBatchingSceneIndex.h>

Inheritance diagram for HdsiPrimTypeNoticeBatchingSceneIndex:

Classes
struct	_PrimAddedEntry

struct	_PrimDirtiedEntry

class	PrimTypePriorityFunctor

Public Types
using	PrimTypePriorityFunctorHandle = std::shared_ptr< PrimTypePriorityFunctor >

Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr )(TfRefBase const *, bool)

Public Member Functions
HDSI_API	~HdsiPrimTypeNoticeBatchingSceneIndex () override

HDSI_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override

HDSI_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override

HDSI_API void	Flush ()

Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API std::vector < HdSceneIndexBaseRefPtr >	GetInputScenes () const final

Public Member Functions inherited from HdSceneIndexBase
HD_API	HdSceneIndexBase ()

HD_API	~HdSceneIndexBase () override

HD_API void	AddObserver (const HdSceneIndexObserverPtr &observer)

HD_API void	RemoveObserver (const HdSceneIndexObserverPtr &observer)

HdDataSourceBaseHandle	GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const

HD_API void	SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)

HD_API std::string	GetDisplayName () const

HD_API void	SetDisplayName (const std::string &n)

HD_API void	AddTag (const TfToken &tag)

HD_API void	RemoveTag (const TfToken &tag)

HD_API bool	HasTag (const TfToken &tag) const

HD_API TfTokenVector	GetTags () const

Public Member Functions inherited from TfRefBase
	TfRefBase ()

	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

size_t	GetCurrentCount () const
	Return the current reference count of this object. More...

bool	IsUnique () const
	Return true if only one `TfRefPtr` points to this object. More...

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from TfWeakBase
	TfWeakBase ()

	TfWeakBase (const TfWeakBase &)

const TfWeakBase &	__GetTfWeakBase__ () const

const TfWeakBase &	operator= (const TfWeakBase &)

void	EnableNotification2 () const

TF_API void const *	GetUniqueIdentifier () const

Static Public Member Functions
static HdsiPrimTypeNoticeBatchingSceneIndexRefPtr	New (HdSceneIndexBaseRefPtr const &inputScene, HdContainerDataSourceHandle const &inputArgs)

Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Protected Types
using	_PrimAddedOrDirtiedEntry = std::variant< _PrimDirtiedEntry, _PrimAddedEntry >

Protected Member Functions
HDSI_API	HdsiPrimTypeNoticeBatchingSceneIndex (HdSceneIndexBaseRefPtr const &inputScene, HdContainerDataSourceHandle const &inputArgs)

void	_PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override

void	_PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override

void	_PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override

void	_RemovePathFromAddedOrDirtiedPrims (const SdfPath &path)

void	_AddPathToRemovedPrims (const SdfPath &path)

size_t	_GetPriority (const TfToken &primType) const

Protected Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API	HdSingleInputFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)

virtual HD_API void	_PrimsRenamed (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RenamedPrimEntries &entries)

const HdSceneIndexBaseRefPtr &	_GetInputSceneIndex () const

Protected Member Functions inherited from HdSceneIndexBase
HD_API void	_SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)

HD_API void	_SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)

HD_API void	_SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)

HD_API void	_SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries)

HD_API bool	_IsObserved () const

virtual HD_API void	_SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)

Protected Member Functions inherited from TfRefBase
virtual TF_API	~TfRefBase ()

Protected Member Functions inherited from TfWeakBase
	~TfWeakBase ()

TfRefPtr< Tf_Remnant >	_Register () const

template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const

bool	_HasRemnant () const

Protected Attributes
PrimTypePriorityFunctorHandle const	_primTypePriorityFunctor

const size_t	_numPriorities

bool	_populated

std::map< SdfPath, _PrimAddedOrDirtiedEntry >	_addedOrDirtiedPrims

std::set< SdfPath >	_removedPrims

Detailed Description

A filtering scene index batching prim notices by type using a given priority functor. The notices are held back until a call to Flush.

The scene index consolidates prim notices. For example, if we get a several prim dirtied entries for the same path, it will turn into a single entry with the dirty locator set being the union. If we get several prim added and dirtied entries for the same path, it results in a single prim added entry. Added and dirtied entries for paths prefixed by a later prim removed entry will be effectively ignored. A removed entry for a name space ancestor of another removed entry will also be effectively removed.

When Flush is called all removed entries are sent out and then followed by the cummulated added and dirtied prim entries grouped by their prim priority.

The filtering scene index is empty until the first call to Flush.

Definition at line 65 of file primTypeNoticeBatchingSceneIndex.h.

Member Typedef Documentation

using HdsiPrimTypeNoticeBatchingSceneIndex::_PrimAddedOrDirtiedEntry = std::variant<_PrimDirtiedEntry, _PrimAddedEntry>

protected

Definition at line 178 of file primTypeNoticeBatchingSceneIndex.h.

using HdsiPrimTypeNoticeBatchingSceneIndex::PrimTypePriorityFunctorHandle = std::shared_ptr<PrimTypePriorityFunctor>

Definition at line 95 of file primTypeNoticeBatchingSceneIndex.h.

Constructor & Destructor Documentation

HDSI_API HdsiPrimTypeNoticeBatchingSceneIndex::~HdsiPrimTypeNoticeBatchingSceneIndex ( )

override

HDSI_API HdsiPrimTypeNoticeBatchingSceneIndex::HdsiPrimTypeNoticeBatchingSceneIndex	(	HdSceneIndexBaseRefPtr const &	inputScene,
		HdContainerDataSourceHandle const &	inputArgs
	)

protected

Member Function Documentation

void HdsiPrimTypeNoticeBatchingSceneIndex::_AddPathToRemovedPrims ( const SdfPath & path )

protected

size_t HdsiPrimTypeNoticeBatchingSceneIndex::_GetPriority ( const TfToken & primType ) const

protected

void HdsiPrimTypeNoticeBatchingSceneIndex::_PrimsAdded	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::AddedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdsiPrimTypeNoticeBatchingSceneIndex::_PrimsDirtied	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::DirtiedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdsiPrimTypeNoticeBatchingSceneIndex::_PrimsRemoved	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::RemovedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdsiPrimTypeNoticeBatchingSceneIndex::_RemovePathFromAddedOrDirtiedPrims ( const SdfPath & path )

protected

HDSI_API void HdsiPrimTypeNoticeBatchingSceneIndex::Flush ( )

Sends out all notices queued and commulated since the last call to Flush. The first call to Flush will also send out notices for prims that were in the input scene index when it was added to this filtering scene index.

HDSI_API SdfPathVector HdsiPrimTypeNoticeBatchingSceneIndex::GetChildPrimPaths ( const SdfPath & primPath ) const

overridevirtual

Forwards to input scene after first call to Flush. Empty before that.

Implements HdSceneIndexBase.

HDSI_API HdSceneIndexPrim HdsiPrimTypeNoticeBatchingSceneIndex::GetPrim ( const SdfPath & primPath ) const

overridevirtual

Forwards to input scene after first call to Flush. Empty before that.

Implements HdSceneIndexBase.

static HdsiPrimTypeNoticeBatchingSceneIndexRefPtr HdsiPrimTypeNoticeBatchingSceneIndex::New	(	HdSceneIndexBaseRefPtr const &	inputScene,
		HdContainerDataSourceHandle const &	inputArgs
	)

inlinestatic

Creates a new notice batching scene index. It expects a priority functor in a PrimTypePriorityFunctorHandle typed data source at HdsiPrimTypeNoticeBatchingSceneIndexTokens->primTypePriorityFunctor in the given inputArgs.

Definition at line 102 of file primTypeNoticeBatchingSceneIndex.h.