This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
HdMergingSceneIndex Class Reference

Merges multiple scenes together. More...

#include <mergingSceneIndex.h>

+ Inheritance diagram for HdMergingSceneIndex:

Public Member Functions

HD_API void AddInputScene (const HdSceneIndexBaseRefPtr &inputScene, const SdfPath &activeInputSceneRoot)
 Adds a scene with activeInputSceneRoot specifying the shallowest path at which prims should be considered.
 
HD_API void RemoveInputScene (const HdSceneIndexBaseRefPtr &sceneIndex)
 
HD_API std::vector< HdSceneIndexBaseRefPtr > GetInputScenes () const override
 satisfying HdFilteringSceneIndex
 
HD_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 Returns a pair of (prim type, datasource) for the object at primPath.
 
HD_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 Returns the paths of all scene index prims located immediately below primPath.
 
virtual std::vector< HdSceneIndexBaseRefPtr > GetInputScenes () const =0
 
- Public Member Functions inherited from HdSceneIndexBase
HD_API void AddObserver (const HdSceneIndexObserverPtr &observer)
 Adds an observer to this scene index.
 
HD_API void RemoveObserver (const HdSceneIndexObserverPtr &observer)
 Removes an observer from this scene index; the given observer will no longer be forwarded notices.
 
virtual HdSceneIndexPrim GetPrim (const SdfPath &primPath) const =0
 Returns a pair of (prim type, datasource) for the object at primPath.
 
virtual SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const =0
 Returns the paths of all scene index prims located immediately below primPath.
 
HdDataSourceBaseHandle GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const
 A convenience function: look up the object at primPath, and if successful return the datasource at locator within that prim.
 
HD_API void SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
 Sends a message with optional arguments to this and any upstream input scene indices.
 
HD_API std::string GetDisplayName () const
 Returns a value previously set by SetDisplayName.
 
HD_API void SetDisplayName (const std::string &n)
 Allows for scene index instances to be identified in a more contextually relevant way.
 
HD_API void AddTag (const TfToken &tag)
 Adds a specified tag token to a scene index instance.
 
HD_API void RemoveTag (const TfToken &tag)
 Removes a specified tag token to a scene index instance.
 
HD_API bool HasTag (const TfToken &tag) const
 Returns true if a specified tag token has been added to a scene index instance.
 
HD_API TfTokenVector GetTags () const
 Returns all tag tokens currently added to a scene index instance.
 
- Public Member Functions inherited from TfRefBase
 TfRefBase (TfRefBase const &)
 
TfRefBaseoperator= (TfRefBase const &)
 
size_t GetCurrentCount () const
 Return the current reference count of this object.
 
bool IsUnique () const
 Return true if only one TfRefPtr points to this object.
 
void SetShouldInvokeUniqueChangedListener (bool shouldCall)
 
- Public Member Functions inherited from 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)
 

Friends

class _Observer
 

Additional Inherited Members

- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr) (TfRefBase const *, bool)
 
- Protected Member Functions inherited from HdSceneIndexBase
HD_API void _SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)
 Notify attached observers of prims added to the scene.
 
HD_API void _SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)
 Notify attached observers of prims removed from the scene.
 
HD_API void _SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
 Notify attached observers of datasource invalidations from the scene.
 
HD_API void _SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries)
 Notify attached observers of prims (and their descendents) which have been renamed or reparented.
 
HD_API bool _IsObserved () const
 Returns whether the scene index has any registered observers; this information can be used to skip work preparing notices when there are no observers.
 
virtual HD_API void _SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
 Implement in order to react directly to system messages sent from downstream.
 
- Protected Member Functions inherited from TfWeakBase
TfRefPtr< Tf_Remnant > _Register () const
 
template<class T >
TfRefPtr< Tf_Remnant > _Register (T *tempRmnt) const
 
bool _HasRemnant () const
 

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 25 of file mergingSceneIndex.h.

Member Function Documentation

◆ AddInputScene()

HD_API void 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.

◆ GetChildPrimPaths()

HD_API SdfPathVector 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.

◆ GetInputScenes()

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

satisfying HdFilteringSceneIndex

Implements HdFilteringSceneIndexBase.

◆ GetPrim()

HD_API HdSceneIndexPrim 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.

◆ New()

static HdMergingSceneIndexRefPtr New ( )
inlinestatic

Definition at line 29 of file mergingSceneIndex.h.

Friends And Related Function Documentation

◆ _Observer

friend class _Observer
friend

Definition at line 74 of file mergingSceneIndex.h.


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