HdSingleInputFilteringSceneIndexBase Class Reference

An abstract base class for a filtering scene index that observes a single input scene index. More...

Inheritance diagram for HdSingleInputFilteringSceneIndexBase:

Public Member Functions
HD_API std::vector< HdSceneIndexBaseRefPtr >	GetInputScenes () const final
Public Member Functions inherited from HdSceneIndexBase
HD_API void	AddObserver (const HdSceneIndexObserverPtr &observer)
	Adds an observer to this scene index. More...
HD_API void	RemoveObserver (const HdSceneIndexObserverPtr &observer)
	Removes an observer from this scene index; the given observer will no longer be forwarded notices. More...
virtual HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const =0
	Returns a pair of (prim type, datasource) for the object at primPath. More...
virtual SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const =0
	Returns the paths of all scene index prims located immediately below primPath. More...
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. More...
Public Member Functions inherited from TfRefBase
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...
const TfRefCount &	GetRefCount () const
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

Protected Member Functions
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
const HdSceneIndexBaseRefPtr &	_GetInputSceneIndex () const
	Returns the input scene. More...
Protected Member Functions inherited from HdSceneIndexBase
HD_API void	_SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)
	Notify attached observers of prims added to the scene. More...
HD_API void	_SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)
	Notify attached observers of prims removed from the scene. More...
HD_API void	_SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
	Notify attached observers of datasource invalidations from the scene. More...
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. More...
Protected Member Functions inherited from TfWeakBase
TfRefPtr< Tf_Remnant >	_Register () const
template<class T >
TfRefPtr< Tf_Remnant >	_Register (T *tempRmnt) const
bool	_HasRemnant () const

Friends
class	_Observer

Additional Inherited Members
Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr) (TfRefBase const *, bool)
Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Detailed Description

An abstract base class for a filtering scene index that observes a single input scene index.

Definition at line 67 of file filteringSceneIndex.h.

Member Function Documentation

_GetInputSceneIndex()

const HdSceneIndexBaseRefPtr& _GetInputSceneIndex ( ) const

inlineprotected

Returns the input scene.

It is always safe to call and dereference this return value. If this was constructed with a null scene index, a fallback one will be used.

Definition at line 94 of file filteringSceneIndex.h.

---

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

• pxr/imaging/hd/filteringSceneIndex.h