HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HdSiExtComputationPrimvarPruningSceneIndex Class Reference

#include <extComputationPrimvarPruningSceneIndex.h>

+ Inheritance diagram for HdSiExtComputationPrimvarPruningSceneIndex:

Public Member Functions

HDSI_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const overridefinal
 
HDSI_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const overridefinal
 
- Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API std::vector
< HdSceneIndexBaseRefPtr > 		GetInputScenes () const final
 
- Public Member Functions inherited from HdSceneIndexBase
HD_API HdSceneIndexBase ()
 
HD_API ~HdSceneIndexBase () override
 
HD_API void AddObserver (const HdSceneIndexObserverPtr &observer)
 
HD_API void RemoveObserver (const HdSceneIndexObserverPtr &observer)
 
HdDataSourceBaseHandle GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const
 
HD_API std::string GetDisplayName () const
 
HD_API void SetDisplayName (const std::string &n)
 
HD_API void AddTag (const TfToken &tag)
 
HD_API void RemoveTag (const TfToken &tag)
 
HD_API bool HasTag (const TfToken &tag) const
 
HD_API TfTokenVector GetTags () const
 
- Public Member Functions inherited from TfRefBase
 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 TfRefCount & GetRefCount () const
 
void SetShouldInvokeUniqueChangedListener (bool shouldCall)
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase ()
 
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase & __GetTfWeakBase__ () const
 
const TfWeakBase & operator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Static Public Member Functions

static HDSI_API
HdSiExtComputationPrimvarPruningSceneIndexRefPtr 		New (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

HDSI_API void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) overridefinal
 
HDSI_API void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) overridefinal
 
HDSI_API void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) overridefinal
 
HDSI_API HdSiExtComputationPrimvarPruningSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
- Protected Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API HdSingleInputFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
virtual HD_API void _PrimsRenamed (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RenamedPrimEntries &entries)
 
const HdSceneIndexBaseRefPtr & _GetInputSceneIndex () const
 
- Protected Member Functions inherited from HdSceneIndexBase
HD_API void _SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)
 
HD_API void _SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)
 
HD_API void _SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
 
HD_API void _SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries)
 
HD_API bool _IsObserved () const
 
- Protected Member Functions inherited from TfRefBase
virtual TF_API ~TfRefBase ()
 
- Protected Member Functions inherited from TfWeakBase
 ~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

Hydra ExtComputations provide a simple computation framework allowing primvars to be computed using CPU or GPU kernels. Computed primvars backed by CPU kernels are evaluated during the Hydra sync phase. This disallows transformations on the computed values via scene indices. This scene index alleviates this by pruning computed primvars and presenting them as authored primvars. The computation is executed when pulling on the primvar's value. Thus, scene indices downstream that take this as an input can transform the (computed) primvar data just like any authored primvar.

Note
This scene index is in service of emulated ExtComputations (i.e., when HD_ENABLE_SCENE_INDEX_EMULATION is true).

Definition at line 52 of file extComputationPrimvarPruningSceneIndex.h.

Constructor & Destructor Documentation

HDSI_API HdSiExtComputationPrimvarPruningSceneIndex::HdSiExtComputationPrimvarPruningSceneIndex ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)
protected

Member Function Documentation

HDSI_API void HdSiExtComputationPrimvarPruningSceneIndex::_PrimsAdded ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::AddedPrimEntries &  entries 
)
finaloverrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

HDSI_API void HdSiExtComputationPrimvarPruningSceneIndex::_PrimsDirtied ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::DirtiedPrimEntries &  entries 
)
finaloverrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

HDSI_API void HdSiExtComputationPrimvarPruningSceneIndex::_PrimsRemoved ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::RemovedPrimEntries &  entries 
)
finaloverrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

HDSI_API SdfPathVector HdSiExtComputationPrimvarPruningSceneIndex::GetChildPrimPaths ( const SdfPath &  primPath) const
finaloverridevirtual

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.

HDSI_API HdSceneIndexPrim HdSiExtComputationPrimvarPruningSceneIndex::GetPrim ( const SdfPath &  primPath) const
finaloverridevirtual

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.

static HDSI_API HdSiExtComputationPrimvarPruningSceneIndexRefPtr HdSiExtComputationPrimvarPruningSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)
static
The documentation for this class was generated from the following file: