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
UsdImagingRenderSettingsFlatteningSceneIndex Class Reference

#include <renderSettingsFlatteningSceneIndex.h>

+ Inheritance diagram for UsdImagingRenderSettingsFlatteningSceneIndex:

Public Member Functions

USDIMAGING_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 
USDIMAGING_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 
- 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 USDIMAGING_API
UsdImagingRenderSettingsFlatteningSceneIndexRefPtr 		New (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

 UsdImagingRenderSettingsFlatteningSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
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)
 
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

Stateless scene index that adds a flattened render settings representation (as modeled by HdRenderSettingsSchema) for downstream consumption by a Hydra render backend, and adds dependencies from the settings prim to the targeted products and vars (using HdDependenciesSchema) so that change notices are forwarded back to appropriate locators on the flattened data source.

Definition at line 42 of file renderSettingsFlatteningSceneIndex.h.

Constructor & Destructor Documentation

UsdImagingRenderSettingsFlatteningSceneIndex::UsdImagingRenderSettingsFlatteningSceneIndex ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)
protected

Member Function Documentation

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

Implements HdSingleInputFilteringSceneIndexBase.

void UsdImagingRenderSettingsFlatteningSceneIndex::_PrimsDirtied ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::DirtiedPrimEntries &  entries 
)
overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void UsdImagingRenderSettingsFlatteningSceneIndex::_PrimsRemoved ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::RemovedPrimEntries &  entries 
)
overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

USDIMAGING_API SdfPathVector UsdImagingRenderSettingsFlatteningSceneIndex::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.

USDIMAGING_API HdSceneIndexPrim UsdImagingRenderSettingsFlatteningSceneIndex::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.

static USDIMAGING_API UsdImagingRenderSettingsFlatteningSceneIndexRefPtr UsdImagingRenderSettingsFlatteningSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)
static
The documentation for this class was generated from the following file: