All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdMergingSceneIndex Class Reference

#include <mergingSceneIndex.h>

+ Inheritance diagram for HdMergingSceneIndex:

Public Member Functions

HD_API void AddInputScene (const HdSceneIndexBaseRefPtr &inputScene, const SdfPath &activeInputSceneRoot)
HD_API void RemoveInputScene (const HdSceneIndexBaseRefPtr &sceneIndex)
HD_API std::vector
< HdSceneIndexBaseRefPtr > 
GetInputScenes () const override
 satisfying HdFilteringSceneIndex More...
HD_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
HD_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
- 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 void SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
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 ()
 TfRefBase (TfRefBase const &)
TfRefBaseoperator= (TfRefBase const &)
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...
void SetShouldInvokeUniqueChangedListener (bool shouldCall)
- Public Member Functions inherited from TfWeakBase
 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 HdMergingSceneIndexRefPtr New ()
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)

Protected Member Functions

HD_API HdMergingSceneIndex ()
- 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
virtual HD_API void _SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
- 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


class _Observer

Additional Inherited Members

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

Detailed Description

Merges multiple scenes together. For prims which exist in more than one input scene, data sources are overlayed (down to the leaf) with the earlier inserted scene having the stronger opinion. NOTE: This is currently the only example of a multi-input scene index and therefore that pattern hasn't yet been broken into a base class.

Definition at line 42 of file mergingSceneIndex.h.

Constructor & Destructor Documentation

HD_API HdMergingSceneIndex::HdMergingSceneIndex ( )

Member Function Documentation

HD_API void HdMergingSceneIndex::AddInputScene ( const HdSceneIndexBaseRefPtr &  inputScene,
const SdfPath activeInputSceneRoot 

Adds a scene with activeInputSceneRoot specifying the shallowest path at which prims should be considered. This is an optional optimization to avoid having to query multiple inputs when it's known in advance which might be relevant for a given prim.

HD_API SdfPathVector HdMergingSceneIndex::GetChildPrimPaths ( const SdfPath primPath) const

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.

HD_API std::vector<HdSceneIndexBaseRefPtr> HdMergingSceneIndex::GetInputScenes ( ) const

satisfying HdFilteringSceneIndex

Implements HdFilteringSceneIndexBase.

HD_API HdSceneIndexPrim HdMergingSceneIndex::GetPrim ( const SdfPath primPath) const

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 HdMergingSceneIndexRefPtr HdMergingSceneIndex::New ( )

Definition at line 46 of file mergingSceneIndex.h.

HD_API void HdMergingSceneIndex::RemoveInputScene ( const HdSceneIndexBaseRefPtr &  sceneIndex)

Friends And Related Function Documentation

friend class _Observer

Definition at line 91 of file mergingSceneIndex.h.

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