HdMergingSceneIndex Class Reference

#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. More...
HD_API void	RemoveInputScenes (const std::vector< HdSceneIndexBaseRefPtr > &sceneIndices)
	Removes given scenes. More...
HD_API void	AddInputScene (const HdSceneIndexBaseRefPtr &inputScene, const SdfPath &activeInputSceneRoot)
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 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 &)
TfRefBase &	operator= (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 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)

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

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

Constructor & Destructor Documentation

HD_API HdMergingSceneIndex::HdMergingSceneIndex ( )

protected

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.

Equivalent to InsertInputScenes({inputScene, activeInputSceneRoot}).

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

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

overridevirtual

satisfying HdFilteringSceneIndex

Implements HdFilteringSceneIndexBase.

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

HD_API void HdMergingSceneIndex::InsertInputScene	(	size_t	pos,
		const HdSceneIndexBaseRefPtr &	inputScene,
		const SdfPath &	activeInputSceneRoot
	)

HD_API void HdMergingSceneIndex::InsertInputScenes

(

const std::vector< InputScene > &

inputScenes

)

Adds given scenes.

static HdMergingSceneIndexRefPtr HdMergingSceneIndex::New ( )

inlinestatic

Definition at line 33 of file mergingSceneIndex.h.

HD_API void HdMergingSceneIndex::RemoveInputScene

(

const HdSceneIndexBaseRefPtr &

sceneIndex

)

HD_API void HdMergingSceneIndex::RemoveInputScenes

(

const std::vector< HdSceneIndexBaseRefPtr > &

sceneIndices

)

Removes given scenes.

Friends And Related Function Documentation

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