HdFlatteningSceneIndex Class Reference

A scene index that observes an input scene index and produces a comparable scene in which inherited state is represented at leaf prims. More...

+ Inheritance diagram for HdFlatteningSceneIndex:

Public Member Functions

HD_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 Returns a pair of (prim type, datasource) for the object at primPath. More...
 
HD_API 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 HdSingleInputFilteringSceneIndexBase
HD_API std::vector< HdSceneIndexBaseRefPtr > GetInputScenes () const final
 
- 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 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
 

Static Public Member Functions

static HdFlatteningSceneIndexRefPtr New (const HdSceneIndexBaseRefPtr &inputScene)
 Creates a new flattening scene index. More...
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

HD_API HdFlatteningSceneIndex (const HdSceneIndexBaseRefPtr &inputScene)
 
void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override
 
void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override
 
void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
 
- Protected Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API HdSingleInputFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
const HdSceneIndexBaseRefPtr & _GetInputSceneIndex () const
 
- 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
 

Friends

class _PrimLevelWrappingDataSource
 

Additional Inherited Members

- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr) (TfRefBase const *, bool)
 

Detailed Description

A scene index that observes an input scene index and produces a comparable scene in which inherited state is represented at leaf prims.

This kind of representation is typically required for legacy-style render delegates that require all the information to be available at the leaf prims.

Definition at line 48 of file flatteningSceneIndex.h.

Member Function Documentation

◆ GetChildPrimPaths()

HD_API SdfPathVector GetChildPrimPaths ( const SdfPath primPath) const
overridevirtual

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.

Implements HdSceneIndexBase.

◆ GetPrim()

HD_API HdSceneIndexPrim GetPrim ( const SdfPath primPath) const
overridevirtual

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.

Implements HdSceneIndexBase.

◆ New()

static HdFlatteningSceneIndexRefPtr New ( const HdSceneIndexBaseRefPtr &  inputScene)
inlinestatic

Creates a new flattening scene index.

Definition at line 54 of file flatteningSceneIndex.h.


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