HdGpGenerativeProceduralResolvingSceneIndex Class Reference

HdGpGenerativeProceduralResolvingSceneIndex is a scene index which evaluates prims representing generative procedurals within its incoming scene and outputs their resulting prims its own observers. More...

+ Inheritance diagram for HdGpGenerativeProceduralResolvingSceneIndex:

Public Member Functions

HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 SATISFYING HdSceneIndexBase ///////////////////////////////////////////. 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 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 HdGpGenerativeProceduralResolvingSceneIndexRefPtr New (const HdSceneIndexBaseRefPtr &inputScene)
 
static HdGpGenerativeProceduralResolvingSceneIndexRefPtr New (const HdSceneIndexBaseRefPtr &inputScene, const TfToken &targetPrimTypeName)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

 HdGpGenerativeProceduralResolvingSceneIndex (const HdSceneIndexBaseRefPtr &inputScene)
 
 HdGpGenerativeProceduralResolvingSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const TfToken &targetPrimTypeName)
 
void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override
 SATISFYING HdSingleInputFilteringSceneIndexBase ///////////////////////. More...
 
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
 Returns the input scene. More...
 
- 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
 

Additional Inherited Members

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

Detailed Description

HdGpGenerativeProceduralResolvingSceneIndex is a scene index which evaluates prims representing generative procedurals within its incoming scene and outputs their resulting prims its own observers.

The hydra prim type used to identify generative procedurals can be configured per instance of this scene index to allow for a pipeline to stage when certain procedural prims are resolved within the chain of scene indicies. By default that type is "generativeProcedural".

This scene index also re-types (to its observers) any procedural prim it acts upon to be of type "resolvedGenerativeProcedural" to avoid potentially evaluating a single procedural multiple times.

In its current form, it does NOT recursively resolve any procedural prims which are the result of the procedural prims for which it is itself evaluting. Additionally, all procedural prims evaluated here see the same input scene – and not the results of other procedurals resolved by the same scene index instance.

Definition at line 62 of file generativeProceduralResolvingSceneIndex.h.

Member Function Documentation

◆ _PrimsAdded()

void _PrimsAdded ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::AddedPrimEntries entries 
)
overrideprotectedvirtual

SATISFYING HdSingleInputFilteringSceneIndexBase ///////////////////////.

Implements HdSingleInputFilteringSceneIndexBase.

◆ GetChildPrimPaths()

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

HdSceneIndexPrim GetPrim ( const SdfPath primPath) const
overridevirtual

SATISFYING HdSceneIndexBase ///////////////////////////////////////////.

Implements HdSceneIndexBase.


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