Public Member Functions | List of all members
HdxSelectionSceneIndexObserver Class Reference

Queries each prim of the given scene index for the HdSelectionsSchema to compute a HdSelection. More...

+ Inheritance diagram for HdxSelectionSceneIndexObserver:

Public Member Functions

HDX_API void SetSceneIndex (HdSceneIndexBaseRefPtr const &sceneIndex)
 Set which scene index to query for selection. More...
 
HDX_API int GetVersion () const
 Increased every time the selection in the scene index gets dirtied (or a difference scene index is set). More...
 
HDX_API HdSelectionSharedPtr GetSelection ()
 Get the result of querying the scene index for the selection as HdSelection. More...
 
HDX_API void PrimsAdded (const HdSceneIndexBase &sender, const AddedPrimEntries &entries) override
 A notification indicating prims have been added to the scene. More...
 
HDX_API void PrimsDirtied (const HdSceneIndexBase &sender, const DirtiedPrimEntries &entries) override
 A notification indicating prim datasources have been invalidated. More...
 
HDX_API void PrimsRemoved (const HdSceneIndexBase &sender, const RemovedPrimEntries &entries) override
 A notification indicating prims have been removed from the scene. 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

- Public Types inherited from HdSceneIndexObserver
using AddedPrimEntries = TfSmallVector< AddedPrimEntry, 16 >
 
using RemovedPrimEntries = TfSmallVector< RemovedPrimEntry, 16 >
 
using DirtiedPrimEntries = TfSmallVector< DirtiedPrimEntry, 16 >
 
- 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

Queries each prim of the given scene index for the HdSelectionsSchema to compute a HdSelection.

Definition at line 39 of file selectionSceneIndexObserver.h.

Member Function Documentation

◆ GetSelection()

HDX_API HdSelectionSharedPtr GetSelection ( )

Get the result of querying the scene index for the selection as HdSelection.

◆ GetVersion()

HDX_API int GetVersion ( ) const

Increased every time the selection in the scene index gets dirtied (or a difference scene index is set).

◆ PrimsAdded()

HDX_API void PrimsAdded ( const HdSceneIndexBase &  sender,
const AddedPrimEntries &  entries 
)
overridevirtual

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.

Implements HdSceneIndexObserver.

◆ PrimsDirtied()

HDX_API void PrimsDirtied ( const HdSceneIndexBase &  sender,
const DirtiedPrimEntries &  entries 
)
overridevirtual

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.

Implements HdSceneIndexObserver.

◆ PrimsRemoved()

HDX_API void PrimsRemoved ( const HdSceneIndexBase &  sender,
const RemovedPrimEntries &  entries 
)
overridevirtual

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.

Implements HdSceneIndexObserver.

◆ SetSceneIndex()

HDX_API void SetSceneIndex ( HdSceneIndexBaseRefPtr const &  sceneIndex)

Set which scene index to query for selection.

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