HdMergingSceneIndex Class Reference

Merges multiple scenes together. More...

#include <mergingSceneIndex.h>

Inheritance diagram for HdMergingSceneIndex:

Classes
struct	InputScene
	Entry to add a scene to the merging scene index. More...

Public Member Functions
HD_API void	InsertInputScenes (const std::vector< InputScene > &inputScenes)
	Adds given scenes.
HD_API void	RemoveInputScenes (const std::vector< HdSceneIndexBaseRefPtr > &sceneIndices)
	Removes given scenes.
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	InsertInputScene (size_t pos, const HdSceneIndexBaseRefPtr &inputScene, const SdfPath &activeInputSceneRoot)
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).
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).
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 &)
TfRefBase &	operator= (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 TfWeakBase &	operator= (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 29 of file mergingSceneIndex.h.

---

Class Documentation

HdMergingSceneIndex::InputScene

struct HdMergingSceneIndex::InputScene

Entry to add a scene to the merging scene index.

Definition at line 38 of file mergingSceneIndex.h.

Class Members
SdfPath	activeInputSceneRoot = SdfPath::AbsoluteRootPath()	The shallowest path at which prims in the scene 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.
size_t	pos = std::numeric_limits<size_t>::max()	The position where to insert the scene. By default (or when larger when current number of scenes in the merging scene index), inserts new scene after the last scene in the merging scene index.
HdSceneIndexBaseRefPtr	scene	The scene to add.

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.

Equivalent to InsertInputScenes({inputScene, activeInputSceneRoot}).

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. The traveral is expected to give exactly the set of paths where prim exists as defined in GetPrim. The traversal is also 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).

A prim exists at primPath if and only if datasource is a non-null pointer. In particular, we consider the prim to exist even if the prim type or the container that datasource points to is empty.

Note that we require GetChildPrimPaths to be consistent with this notion of prim existence. That is, unless primPath is the absolute root path, the prim at primPath exists if and only if primPath is contained in GetChildPrimPaths of the parent path.

This function is expected to be threadsafe.

Implements HdSceneIndexBase.

InsertInputScenes()

HD_API void InsertInputScenes

(

const std::vector< InputScene > &

inputScenes

)

Adds given scenes.

New()

static HdMergingSceneIndexRefPtr New ( )

inlinestatic

Definition at line 33 of file mergingSceneIndex.h.

RemoveInputScenes()

HD_API void RemoveInputScenes

(

const std::vector< HdSceneIndexBaseRefPtr > &

sceneIndices

)

Removes given scenes.

Friends And Related Function Documentation

_Observer

friend class _Observer

friend

Definition at line 112 of file mergingSceneIndex.h.

---

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

• pxr/imaging/hd/mergingSceneIndex.h