HdLegacyPrimSceneIndex Class Reference

Extends HdRetainedSceneIndex to instantiate and dirty HdDataSourceLegacyPrim data sources. More...

+ Inheritance diagram for HdLegacyPrimSceneIndex:

Public Member Functions

void AddLegacyPrim (SdfPath const &id, TfToken const &type, HdSceneDelegate *sceneDelegate)
 custom insertion wrapper called by HdRenderIndex during population of legacy HdSceneDelegates More...
 
void DirtyPrims (const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
 extends to also call DirtyPrim on HdDataSourceLegacyPrim More...
 
- Public Member Functions inherited from HdRetainedSceneIndex
virtual void AddPrims (const AddedPrimEntries &entries)
 Add a prim to the retained scene index. More...
 
virtual void RemovePrims (const HdSceneIndexObserver::RemovedPrimEntries &entries)
 Removes a prim subtree from the retained scene index. More...
 
HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 Returns a pair of (prim type, datasource) for the object at primPath. More...
 
SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 Returns the paths of all scene index prims located immediately below primPath. More...
 
- 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
 

Static Public Member Functions

static HdLegacyPrimSceneIndexRefPtr New ()
 
- Static Public Member Functions inherited from HdRetainedSceneIndex
static HdRetainedSceneIndexRefPtr New ()
 Creates a new retained scene index. More...
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Additional Inherited Members

- Public Types inherited from HdRetainedSceneIndex
using AddedPrimEntries = std::vector< AddedPrimEntry >
 
- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr) (TfRefBase const *, bool)
 
- 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
 

Detailed Description

Extends HdRetainedSceneIndex to instantiate and dirty HdDataSourceLegacyPrim data sources.

During emulation of legacy HdSceneDelegates, HdRenderIndex forwards prim insertion calls here to produce a comparable HdSceneIndex representation

Definition at line 43 of file legacyPrimSceneIndex.h.

Member Function Documentation

◆ AddLegacyPrim()

void AddLegacyPrim ( SdfPath const &  id,
TfToken const &  type,
HdSceneDelegate *  sceneDelegate 
)

custom insertion wrapper called by HdRenderIndex during population of legacy HdSceneDelegates

◆ DirtyPrims()

void DirtyPrims ( const HdSceneIndexObserver::DirtiedPrimEntries &  entries)
overridevirtual

extends to also call DirtyPrim on HdDataSourceLegacyPrim

Reimplemented from HdRetainedSceneIndex.


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