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
HdsiPrimTypePruningSceneIndex Class Referencefinal

#include <primTypePruningSceneIndex.h>

+ Inheritance diagram for HdsiPrimTypePruningSceneIndex:

Public Member Functions

HDSI_API bool GetEnabled () const
 Is scene index actually prunning? More...
 
HDSI_API void SetEnabled (bool)
 Enable scene index to prune. More...
 
HDSI_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 
HDSI_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 
const TfToken & GetBindingToken () const
 
- 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
HdsiPrimTypePruningSceneIndexRefPtr 		New (HdSceneIndexBaseRefPtr const &inputSceneIndex, HdContainerDataSourceHandle const &inputArgs)
 
- 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) override
 
HDSI_API void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override
 
HDSI_API void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
 
HDSI_API HdsiPrimTypePruningSceneIndex (HdSceneIndexBaseRefPtr const &inputSceneIndex, HdContainerDataSourceHandle const &inputArgs)
 
HDSI_API ~HdsiPrimTypePruningSceneIndex () 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

Scene Index that prunes prims of given type (e.g., material) and (optionally) bindings to that prim type (e.g., materialBindings).

Pruned prims are not removed from the scene index; instead, they are given an empty primType and null dataSource. This is to preserve hierarchy and allow children of the pruned types to still exist.

An optional bool argument specifies whether to suppress pruning for prims at non-prim paths, and, correspondingly, leave bindings to prims at non-prim paths unchanged.

By default, when creating the scene index, it is disabled and does not pruning anything.

If an empty binding token is used, the scene index will not prune any binding.

Definition at line 62 of file primTypePruningSceneIndex.h.

Constructor & Destructor Documentation

HDSI_API HdsiPrimTypePruningSceneIndex::HdsiPrimTypePruningSceneIndex ( HdSceneIndexBaseRefPtr const &  inputSceneIndex,
HdContainerDataSourceHandle const &  inputArgs 
)
protected
HDSI_API HdsiPrimTypePruningSceneIndex::~HdsiPrimTypePruningSceneIndex ( )
overrideprotected

Member Function Documentation

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

Implements HdSingleInputFilteringSceneIndexBase.

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

Implements HdSingleInputFilteringSceneIndexBase.

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

Implements HdSingleInputFilteringSceneIndexBase.

const TfToken& HdsiPrimTypePruningSceneIndex::GetBindingToken ( ) const
inline

Definition at line 84 of file primTypePruningSceneIndex.h.

HDSI_API SdfPathVector HdsiPrimTypePruningSceneIndex::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.

HDSI_API bool HdsiPrimTypePruningSceneIndex::GetEnabled ( ) const

Is scene index actually prunning?

HDSI_API HdSceneIndexPrim HdsiPrimTypePruningSceneIndex::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 HDSI_API HdsiPrimTypePruningSceneIndexRefPtr HdsiPrimTypePruningSceneIndex::New ( HdSceneIndexBaseRefPtr const &  inputSceneIndex,
HdContainerDataSourceHandle const &  inputArgs 
)
static
HDSI_API void HdsiPrimTypePruningSceneIndex::SetEnabled ( bool  )

Enable scene index to prune.

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