Classes | Public Types | Public Member Functions | List of all members
HdSceneIndexObserver Class Referenceabstract

Observer of scene data. More...

+ Inheritance diagram for HdSceneIndexObserver:

Classes

struct  AddedPrimEntry
 A notice indicating a prim of a given type was added to the scene. More...
 
struct  DirtiedPrimEntry
 A notice indicating a prim was invalidated. More...
 
struct  RemovedPrimEntry
 A notice indicating a prim subtree was removed from the scene. More...
 

Public Types

using AddedPrimEntries = TfSmallVector< AddedPrimEntry, 16 >
 
using RemovedPrimEntries = TfSmallVector< RemovedPrimEntry, 16 >
 
using DirtiedPrimEntries = TfSmallVector< DirtiedPrimEntry, 16 >
 

Public Member Functions

virtual HD_API void PrimsAdded (const HdSceneIndexBase &sender, const AddedPrimEntries &entries)=0
 A notification indicating prims have been added to the scene. More...
 
virtual HD_API void PrimsRemoved (const HdSceneIndexBase &sender, const RemovedPrimEntries &entries)=0
 A notification indicating prims have been removed from the scene. More...
 
virtual HD_API void PrimsDirtied (const HdSceneIndexBase &sender, const DirtiedPrimEntries &entries)=0
 A notification indicating prim datasources have been invalidated. More...
 
- 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
 

Additional Inherited Members

- 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

Observer of scene data.

From the time an observer is registered with a scene index, the scene index will send it diffs as the scene changes.

Definition at line 48 of file sceneIndexObserver.h.

Member Function Documentation

◆ PrimsAdded()

virtual HD_API void PrimsAdded ( const HdSceneIndexBase &  sender,
const AddedPrimEntries &  entries 
)
pure virtual

A notification indicating prims have been added to the scene.

The set of scene prims compiled from added/removed notices should match the set from a traversal based on sender.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 expected to be threadsafe.

Implemented in HdSceneIndexAdapterSceneDelegate, and HdxSelectionSceneIndexObserver.

◆ PrimsDirtied()

virtual HD_API void PrimsDirtied ( const HdSceneIndexBase &  sender,
const DirtiedPrimEntries &  entries 
)
pure virtual

A notification indicating prim datasources have been invalidated.

This message is not considered hierarchical on primPath; if /Path is dirtied, /Path/child is not necessarily dirtied. However datasource locators are considered hierarchical: if primvars is dirtied on a prim, primvars/color is considered dirtied as well. This function is not expected to be threadsafe.

Implemented in HdSceneIndexAdapterSceneDelegate, and HdxSelectionSceneIndexObserver.

◆ PrimsRemoved()

virtual HD_API void PrimsRemoved ( const HdSceneIndexBase &  sender,
const RemovedPrimEntries &  entries 
)
pure virtual

A notification indicating prims have been 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 expected to be threadsafe.

Implemented in HdxSelectionSceneIndexObserver, and HdSceneIndexAdapterSceneDelegate.

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