HdsiTerminalsResolvingSceneIndex Class Referencefinal

SceneIndex that "resolves" terminals by renaming them from their context specific names (i.e. More...

+ Inheritance diagram for HdsiTerminalsResolvingSceneIndex:

Static Public Member Functions

static HDSI_API HdsiTerminalsResolvingSceneIndexRefPtr New (const HdSceneIndexBaseRefPtr &inputSceneIndex, const std::map< TfToken, TfToken > &terminalRemappings)
 
static HDSI_API void ResolveTerminals (HdMaterialNetworkInterface *interface, const std::map< TfToken, TfToken > &terminalRemappings)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

FilteringFnc _GetFilteringFunction () const override
 
 HdsiTerminalsResolvingSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex, const std::map< TfToken, TfToken > &terminalRemappings)
 
- Protected Member Functions inherited from HdMaterialFilteringSceneIndexBase
HD_API void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override final
 
HD_API void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override final
 
HD_API void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override final
 
HD_API HdMaterialFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
- Protected Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API HdSingleInputFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
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
 

Additional Inherited Members

- Public Types inherited from HdMaterialFilteringSceneIndexBase
using FilteringFnc = std::function< void(HdMaterialNetworkInterface *)>
 
- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr) (TfRefBase const *, bool)
 
- Public Member Functions inherited from HdMaterialFilteringSceneIndexBase
HD_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override final
 Returns a pair of (prim type, datasource) for the object at primPath. More...
 
HD_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override final
 Returns the paths of all scene index prims located immediately below primPath. More...
 
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 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...
 
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
 

Detailed Description

SceneIndex that "resolves" terminals by renaming them from their context specific names (i.e.

"ri:surface") to the HdMaterialTerminalToken ("surface"). The mapping is provided by a terminalRemappings parameter that is passed to the constructor.

Definition at line 43 of file terminalsResolvingSceneIndex.h.


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