HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
HdMaterialFilteringSceneIndexBase Class Referenceabstract

#include <materialFilteringSceneIndexBase.h>

+ Inheritance diagram for HdMaterialFilteringSceneIndexBase:

Public Types

using FilteringFnc = std::function< void(HdMaterialNetworkInterface *)>
 
- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr )(TfRefBase const *, bool)
 

Public Member Functions

HD_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const overridefinal
 
HD_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const overridefinal
 
HD_API FilteringFnc GetFilteringFunction () const
 
- 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 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 ()
 
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 ()
 
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase & __GetTfWeakBase__ () const
 
const TfWeakBase & operator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Protected Member Functions

virtual FilteringFnc _GetFilteringFunction () const =0
 
HD_API void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) overridefinal
 
HD_API void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) overridefinal
 
HD_API void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) overridefinal
 
HD_API HdMaterialFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
- 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
 
- 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
 

Additional Inherited Members

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

Detailed Description

Base class for implementing scene indices which read from and write to only material network data sources. Subclasses implement only _GetFilteringFunction to provide a callback to run when a material network is first queried.

Definition at line 43 of file materialFilteringSceneIndexBase.h.

Member Typedef Documentation

using HdMaterialFilteringSceneIndexBase::FilteringFnc = std::function<void(HdMaterialNetworkInterface *)>

Definition at line 54 of file materialFilteringSceneIndexBase.h.

Constructor & Destructor Documentation

HD_API HdMaterialFilteringSceneIndexBase::HdMaterialFilteringSceneIndexBase ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)
protected

Member Function Documentation

virtual FilteringFnc HdMaterialFilteringSceneIndexBase::_GetFilteringFunction ( ) const
protectedpure virtual
HD_API void HdMaterialFilteringSceneIndexBase::_PrimsAdded ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::AddedPrimEntries &  entries 
)
finaloverrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

Implements HdSingleInputFilteringSceneIndexBase.

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

Implements HdSingleInputFilteringSceneIndexBase.

HD_API SdfPathVector HdMaterialFilteringSceneIndexBase::GetChildPrimPaths ( const SdfPath &  primPath) const
finaloverridevirtual

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 FilteringFnc HdMaterialFilteringSceneIndexBase::GetFilteringFunction ( ) const
HD_API HdSceneIndexPrim HdMaterialFilteringSceneIndexBase::GetPrim ( const SdfPath &  primPath) const
finaloverridevirtual

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.

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