HdSceneIndexBase Class Referenceabstract

Abstract interface to scene data. More...

+ Inheritance diagram for HdSceneIndexBase:

Public Member Functions

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 TfRefCountGetRefCount () const
 
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
 

Protected Member Functions

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 TfRefBase
typedef void(* UniqueChangedFuncPtr) (TfRefBase const *, bool)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Detailed Description

Abstract interface to scene data.

This class can be queried for scene data directly, and it can also register observers to be notified about scene changes (see HdSceneIndexObserver).

Definition at line 62 of file sceneIndex.h.

Member Function Documentation

◆ _IsObserved()

HD_API bool _IsObserved ( ) const
protected

Returns whether the scene index has any registered observers; this information can be used to skip work preparing notices when there are no observers.

◆ _SendPrimsAdded()

HD_API void _SendPrimsAdded ( const HdSceneIndexObserver::AddedPrimEntries entries)
protected

Notify attached observers of prims added to the scene.

The set of scene prims compiled from added/removed notices should match the set from a traversal based on GetChildPrimNames. Each prim has a path and type. It's possible for PrimsAdded to be called for prims that already exist; in that case, observers should be sure to update the prim type, in case it changed, and resync the prim. This function is not threadsafe; some observers expect it to be called from a single thread.

◆ _SendPrimsDirtied()

HD_API void _SendPrimsDirtied ( const HdSceneIndexObserver::DirtiedPrimEntries entries)
protected

Notify attached observers of datasource invalidations from the scene.

This message is not considered hierarchical on primPath; if /Path is dirtied, /Path/child is not necessarily dirtied. However, locators are considered hierarchical: if primvars is dirtied on a prim, primvars/color is considered dirtied as well. This function is not threadsafe; some observers expect it to be called from a single thread.

◆ _SendPrimsRemoved()

HD_API void _SendPrimsRemoved ( const HdSceneIndexObserver::RemovedPrimEntries entries)
protected

Notify attached observers of prims removed from the scene.

Note that this message is considered hierarchical: if /Path is removed, /Path/child is considered removed as well. This function is not threadsafe; some observers expect it to be called from a single thread.

◆ AddObserver()

HD_API void AddObserver ( const HdSceneIndexObserverPtr &  observer)

Adds an observer to this scene index.

The given observer will be sent notices for prims added, removed, or dirtied after it is added as an observer. It will not be sent notices for prims already in the scene index; the calling code is responsible for updating observer state if the scene index has already been populated. This function is not threadsafe.

◆ GetChildPrimPaths()

virtual SdfPathVector GetChildPrimPaths ( const SdfPath primPath) const
pure virtual

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.

Implemented in HdRetainedSceneIndex, HdMergingSceneIndex, HdFlatteningSceneIndex, HdPrefixingSceneIndex, and HdMaterialFilteringSceneIndexBase.

◆ GetDataSource()

HdDataSourceBaseHandle GetDataSource ( const SdfPath primPath,
const HdDataSourceLocator locator 
) const
inline

A convenience function: look up the object at primPath, and if successful return the datasource at locator within that prim.

This is equivalent to calling GetPrim(primPath), and then calling HdContainerDataSource::Get(prim.dataSource, locator).

Definition at line 112 of file sceneIndex.h.

◆ GetPrim()

virtual HdSceneIndexPrim GetPrim ( const SdfPath primPath) const
pure virtual

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.

Implemented in HdRetainedSceneIndex, HdMergingSceneIndex, HdFlatteningSceneIndex, HdPrefixingSceneIndex, and HdMaterialFilteringSceneIndexBase.

◆ RemoveObserver()

HD_API void RemoveObserver ( const HdSceneIndexObserverPtr &  observer)

Removes an observer from this scene index; the given observer will no longer be forwarded notices.

Note that the observer won't get any notices as a result of being detached from this scene index. If observer is not registered on this scene index, this call does nothing. This function is not threadsafe.


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