#include <noticeBatchingSceneIndex.h>

Inheritance diagram for HdNoticeBatchingSceneIndex:

Classes
struct	_BatchEntry

struct	_PrimsAddedBatchEntry

struct	_PrimsDirtiedBatchEntry

struct	_PrimsRemovedBatchEntry

Public Member Functions
HD_API	~HdNoticeBatchingSceneIndex () override

HD_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override

HD_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override

HD_API bool	IsBatchingEnabled () const

HD_API void	SetBatchingEnabled (bool enabled)

HD_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 HdNoticeBatchingSceneIndexRefPtr	New (const HdSceneIndexBaseRefPtr &inputScene)

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

Protected Member Functions
HD_API	HdNoticeBatchingSceneIndex (const HdSceneIndexBaseRefPtr &inputScene)

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

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

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

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
bool	_batchingEnabled

std::vector< std::unique_ptr < _BatchEntry > >	_batches

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

Detailed Description

Definition at line 19 of file noticeBatchingSceneIndex.h.

Constructor & Destructor Documentation

HD_API HdNoticeBatchingSceneIndex::~HdNoticeBatchingSceneIndex ( )

override

HD_API HdNoticeBatchingSceneIndex::HdNoticeBatchingSceneIndex ( const HdSceneIndexBaseRefPtr & inputScene )

protected

Member Function Documentation

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

HD_API void HdNoticeBatchingSceneIndex::Flush ( )

Forwards any queued notices accumuated while batching state is enabled. This does not itself disable batching.

HD_API SdfPathVector HdNoticeBatchingSceneIndex::GetChildPrimPaths ( const SdfPath & primPath ) const

overridevirtual

Returns the paths of all scene index prims located immediately below primPath. This function can be used to traverse the scene by recursing from SdfPath::AbsoluteRootPath(); such a traversal is expected to give the same set of prims as the flattening of the scene index's PrimsAdded and PrimsRemoved messages. This function is expected to be threadsafe.

Implements HdSceneIndexBase.

HD_API HdSceneIndexPrim HdNoticeBatchingSceneIndex::GetPrim ( const SdfPath & primPath ) const

overridevirtual

Returns a pair of (prim type, datasource) for the object at primPath. If no such object exists, the type will be the empty token and the datasource will be null. This function is expected to be threadsafe.

Implements HdSceneIndexBase.

HD_API bool HdNoticeBatchingSceneIndex::IsBatchingEnabled ( ) const

static HdNoticeBatchingSceneIndexRefPtr HdNoticeBatchingSceneIndex::New ( const HdSceneIndexBaseRefPtr & inputScene )

inlinestatic

Creates a new notice batching scene index.

Definition at line 24 of file noticeBatchingSceneIndex.h.

HD_API void HdNoticeBatchingSceneIndex::SetBatchingEnabled ( bool enabled )

Once batching is enabled, observed notices are queued in contiguious blocks by notice type. Disabling batching immediately forwards and flushes any queued batches. Batching state is not currently tracked in a nested manner.

Member Data Documentation

std::vector<std::unique_ptr<_BatchEntry> > HdNoticeBatchingSceneIndex::_batches

protected

Definition at line 97 of file noticeBatchingSceneIndex.h.

bool HdNoticeBatchingSceneIndex::_batchingEnabled

protected

Definition at line 96 of file noticeBatchingSceneIndex.h.

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

pxr/imaging/hd/noticeBatchingSceneIndex.h

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation