A filtering scene index batching prim notices by type using a given priority functor. More...

#include <primTypeNoticeBatchingSceneIndex.h>

Inheritance diagram for HdsiPrimTypeNoticeBatchingSceneIndex:

Classes
class	PrimTypePriorityFunctor
	Base class for functor mapping prim types to priorities. More...

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

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

Public Member Functions
HDSI_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override
	Forwards to input scene after first call to Flush.

HDSI_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override
	Forwards to input scene after first call to Flush.

HDSI_API void	Flush ()
	Sends out all notices queued and commulated since the last call to Flush.

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

virtual std::vector< HdSceneIndexBaseRefPtr >	GetInputScenes () const =0

Public Member Functions inherited from HdSceneIndexBase
HD_API void	AddObserver (const HdSceneIndexObserverPtr &observer)
	Adds an observer to this scene index.

HD_API void	RemoveObserver (const HdSceneIndexObserverPtr &observer)
	Removes an observer from this scene index; the given observer will no longer be forwarded notices.

virtual HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const =0
	Returns a pair of (prim type, datasource) for the object at `primPath`.

virtual SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const =0
	Returns the paths of all scene index prims located immediately below `primPath`.

HdDataSourceBaseHandle	GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const
	A convenience function: look up the object at `primPath`, and if successful return the datasource at `locator` within that prim.

HD_API void	SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
	Sends a message with optional arguments to this and any upstream input scene indices.

HD_API std::string	GetDisplayName () const
	Returns a value previously set by SetDisplayName.

HD_API void	SetDisplayName (const std::string &n)
	Allows for scene index instances to be identified in a more contextually relevant way.

HD_API void	AddTag (const TfToken &tag)
	Adds a specified tag token to a scene index instance.

HD_API void	RemoveTag (const TfToken &tag)
	Removes a specified tag token to a scene index instance.

HD_API bool	HasTag (const TfToken &tag) const
	Returns true if a specified tag token has been added to a scene index instance.

HD_API TfTokenVector	GetTags () const
	Returns all tag tokens currently added to a scene index instance.

Public Member Functions inherited from TfRefBase
	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

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

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

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from 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)
	Creates a new notice batching scene index.

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 void	_PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries)=0

virtual void	_PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries)=0

virtual void	_PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries)=0

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

const HdSceneIndexBaseRefPtr &	_GetInputSceneIndex () const
	Returns the input scene.

Protected Member Functions inherited from HdSceneIndexBase
HD_API void	_SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)
	Notify attached observers of prims added to the scene.

HD_API void	_SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)
	Notify attached observers of prims removed from the scene.

HD_API void	_SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
	Notify attached observers of datasource invalidations from the scene.

HD_API void	_SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries)
	Notify attached observers of prims (and their descendents) which have been renamed or reparented.

HD_API bool	_IsObserved () const
	Returns whether the scene index has any registered observers; this information can be used to skip work preparing notices when there are no observers.

virtual HD_API void	_SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
	Implement in order to react directly to system messages sent from downstream.

Protected Member Functions inherited from 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

◆ _PrimAddedOrDirtiedEntry

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

protected

Definition at line 177 of file primTypeNoticeBatchingSceneIndex.h.

◆ PrimTypePriorityFunctorHandle

using PrimTypePriorityFunctorHandle = std::shared_ptr<PrimTypePriorityFunctor>

Definition at line 94 of file primTypeNoticeBatchingSceneIndex.h.

Member Function Documentation

◆ _PrimsAdded()

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

◆ _PrimsDirtied()

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

◆ _PrimsRemoved()

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

◆ Flush()

HDSI_API void 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.

◆ GetChildPrimPaths()

HDSI_API SdfPathVector GetChildPrimPaths ( const SdfPath & primPath ) const

overridevirtual

Forwards to input scene after first call to Flush.

Empty before that.

Implements HdSceneIndexBase.

◆ GetPrim()

HDSI_API HdSceneIndexPrim GetPrim ( const SdfPath & primPath ) const

overridevirtual

Forwards to input scene after first call to Flush.

Empty before that.

Implements HdSceneIndexBase.

◆ New()

static HdsiPrimTypeNoticeBatchingSceneIndexRefPtr 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.

Member Data Documentation

◆ _addedOrDirtiedPrims

std::map<SdfPath, _PrimAddedOrDirtiedEntry> _addedOrDirtiedPrims

protected

Definition at line 180 of file primTypeNoticeBatchingSceneIndex.h.

◆ _numPriorities

const size_t _numPriorities

protected

Definition at line 160 of file primTypeNoticeBatchingSceneIndex.h.

◆ _populated

bool _populated

protected

Definition at line 173 of file primTypeNoticeBatchingSceneIndex.h.

◆ _primTypePriorityFunctor

PrimTypePriorityFunctorHandle const _primTypePriorityFunctor

protected

Definition at line 159 of file primTypeNoticeBatchingSceneIndex.h.

◆ _removedPrims

std::set<SdfPath> _removedPrims

protected

Definition at line 184 of file primTypeNoticeBatchingSceneIndex.h.

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

pxr/imaging/hdsi/primTypeNoticeBatchingSceneIndex.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ _PrimAddedOrDirtiedEntry

◆ PrimTypePriorityFunctorHandle

Member Function Documentation

◆ _PrimsAdded()

◆ _PrimsDirtied()

◆ _PrimsRemoved()

◆ Flush()

◆ GetChildPrimPaths()

◆ GetPrim()

◆ New()

Member Data Documentation

◆ _addedOrDirtiedPrims

◆ _numPriorities

◆ _populated

◆ _primTypePriorityFunctor

◆ _removedPrims