Loading...
Searching...
No Matches
HdSiNodeIdentifierResolvingSceneIndex Class Reference

Scene index that converts the <sourceType>:sourceAsset info into a nodeType (nodeIdentifier). More...

#include <nodeIdentifierResolvingSceneIndex.h>

+ Inheritance diagram for HdSiNodeIdentifierResolvingSceneIndex:

Static Public Member Functions

static HDSI_API HdSiNodeIdentifierResolvingSceneIndexRefPtr New (HdSceneIndexBaseRefPtr const &inputSceneIndex, const TfToken &sourceType)
 Construct a new instance of HdSiNodeIdentifierResolvingSceneIndex.
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

HDSI_API FilteringFnc _GetFilteringFunction () const override
 
- Protected Member Functions inherited from HdMaterialFilteringSceneIndexBase
virtual FilteringFnc _GetFilteringFunction () const =0
 
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)
 
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
 

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).
 
HD_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override final
 Returns the paths of all scene index prims located immediately below primPath.
 
HD_API FilteringFnc GetFilteringFunction () const
 
- 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).
 
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 &)
 
TfRefBaseoperator= (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 TfWeakBaseoperator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Detailed Description

Scene index that converts the <sourceType>:sourceAsset info into a nodeType (nodeIdentifier).

Definition at line 20 of file nodeIdentifierResolvingSceneIndex.h.

Member Function Documentation

◆ _GetFilteringFunction()

HDSI_API FilteringFnc _GetFilteringFunction ( ) const
overrideprotectedvirtual

◆ New()

static HDSI_API HdSiNodeIdentifierResolvingSceneIndexRefPtr New ( HdSceneIndexBaseRefPtr const &  inputSceneIndex,
const TfToken sourceType 
)
static

Construct a new instance of HdSiNodeIdentifierResolvingSceneIndex.

sourceType indicates the type of the shader's source or its implementation, e.g. OSL, glslfx, riCpp etc. . . See also: UsdShadeNodeDefAPI for more details about sourceType.


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