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

#include <filteringSceneIndex.h>

+ Inheritance diagram for HdSingleInputFilteringSceneIndexBase:

Public Member Functions

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)
 
virtual HdSceneIndexPrim GetPrim (const SdfPath &primPath) const =0
 
virtual SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const =0
 
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
 

Protected Member Functions

HD_API HdSingleInputFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
virtual void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries)=0
 
virtual void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries)=0
 
virtual void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries)=0
 
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
 

Friends

class _Observer
 

Additional Inherited Members

- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr )(TfRefBase const *, bool)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Detailed Description

An abstract base class for a filtering scene index that observes a single input scene index.

Definition at line 65 of file filteringSceneIndex.h.

Constructor & Destructor Documentation

HD_API HdSingleInputFilteringSceneIndexBase::HdSingleInputFilteringSceneIndexBase ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)
protected

Member Function Documentation

const HdSceneIndexBaseRefPtr& HdSingleInputFilteringSceneIndexBase::_GetInputSceneIndex ( ) const
inlineprotected

Returns the input scene.

It is always safe to call and dereference this return value. If this was constructed with a null scene index, a fallback one will be used.

Definition at line 98 of file filteringSceneIndex.h.

virtual void HdSingleInputFilteringSceneIndexBase::_PrimsAdded ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::AddedPrimEntries &  entries 
)
protectedpure virtual

Implemented in HdFlatteningSceneIndex, HdsiCoordSysPrimSceneIndex, HdGpGenerativeProceduralResolvingSceneIndex, HdsiPrimTypePruningSceneIndex, HdsiLegacyDisplayStyleOverrideSceneIndex, HdsiSceneGlobalsSceneIndex, UsdImagingRerootingSceneIndex, UsdImagingDrawModeSceneIndex, HdsiRenderSettingsFilteringSceneIndex, UsdImagingSelectionSceneIndex, HdNoticeBatchingSceneIndex, HdsiPinnedCurveExpandingSceneIndex, HdSiExtComputationPrimvarPruningSceneIndex, HdsiImplicitSurfaceSceneIndex, HdPrefixingSceneIndex, UsdImagingRootOverridesSceneIndex, HdsiMaterialPrimvarTransferSceneIndex, UsdImagingExtentResolvingSceneIndex, HdMaterialFilteringSceneIndexBase, HdDependencyForwardingSceneIndex, UsdImagingUnloadedDrawModeSceneIndex, HdsiNurbsApproximatingSceneIndex, UsdImagingRenderSettingsFlatteningSceneIndex, and HdsiMaterialBindingResolvingSceneIndex.

virtual void HdSingleInputFilteringSceneIndexBase::_PrimsDirtied ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::DirtiedPrimEntries &  entries 
)
protectedpure virtual

Implemented in HdFlatteningSceneIndex, HdsiCoordSysPrimSceneIndex, HdGpGenerativeProceduralResolvingSceneIndex, HdsiPrimTypePruningSceneIndex, HdsiLegacyDisplayStyleOverrideSceneIndex, HdsiSceneGlobalsSceneIndex, UsdImagingRerootingSceneIndex, HdsiRenderSettingsFilteringSceneIndex, UsdImagingDrawModeSceneIndex, HdsiPinnedCurveExpandingSceneIndex, UsdImagingSelectionSceneIndex, HdNoticeBatchingSceneIndex, HdSiExtComputationPrimvarPruningSceneIndex, HdsiImplicitSurfaceSceneIndex, HdPrefixingSceneIndex, HdMaterialFilteringSceneIndexBase, UsdImagingExtentResolvingSceneIndex, HdsiMaterialPrimvarTransferSceneIndex, HdDependencyForwardingSceneIndex, UsdImagingRootOverridesSceneIndex, UsdImagingUnloadedDrawModeSceneIndex, HdsiNurbsApproximatingSceneIndex, UsdImagingRenderSettingsFlatteningSceneIndex, and HdsiMaterialBindingResolvingSceneIndex.

virtual void HdSingleInputFilteringSceneIndexBase::_PrimsRemoved ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::RemovedPrimEntries &  entries 
)
protectedpure virtual

Implemented in HdFlatteningSceneIndex, HdsiCoordSysPrimSceneIndex, HdGpGenerativeProceduralResolvingSceneIndex, HdsiPrimTypePruningSceneIndex, HdsiLegacyDisplayStyleOverrideSceneIndex, HdsiSceneGlobalsSceneIndex, UsdImagingRerootingSceneIndex, HdsiRenderSettingsFilteringSceneIndex, UsdImagingDrawModeSceneIndex, UsdImagingSelectionSceneIndex, HdNoticeBatchingSceneIndex, HdsiPinnedCurveExpandingSceneIndex, HdSiExtComputationPrimvarPruningSceneIndex, HdsiImplicitSurfaceSceneIndex, UsdImagingRootOverridesSceneIndex, HdPrefixingSceneIndex, UsdImagingExtentResolvingSceneIndex, HdMaterialFilteringSceneIndexBase, HdsiMaterialPrimvarTransferSceneIndex, HdDependencyForwardingSceneIndex, UsdImagingUnloadedDrawModeSceneIndex, HdsiNurbsApproximatingSceneIndex, UsdImagingRenderSettingsFlatteningSceneIndex, and HdsiMaterialBindingResolvingSceneIndex.

virtual HD_API void HdSingleInputFilteringSceneIndexBase::_PrimsRenamed ( const HdSceneIndexBase &  sender,
const HdSceneIndexObserver::RenamedPrimEntries &  entries 
)
protectedvirtual
HD_API std::vector<HdSceneIndexBaseRefPtr> HdSingleInputFilteringSceneIndexBase::GetInputScenes ( ) const
finalvirtual

Implements HdFilteringSceneIndexBase.

Friends And Related Function Documentation

friend class _Observer
friend

Definition at line 106 of file filteringSceneIndex.h.

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