#include <flatteningSceneIndex.h>

Inheritance diagram for HdFlatteningSceneIndex:

Public Member Functions
HD_API	~HdFlatteningSceneIndex () override

HD_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override

HD_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override

const TfTokenVector &	GetFlattenedDataSourceNames () const
	Data sources under locator name in a prim source get flattened. More...

const HdFlattenedDataSourceProviderSharedPtrVector &	GetFlattenedDataSourceProviders () const
	Providers in the same order as GetFlattenedDataSourceNames. More...

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 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 HdFlatteningSceneIndexRefPtr	New (HdSceneIndexBaseRefPtr const &inputScene, HdContainerDataSourceHandle const &inputArgs)

Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Protected Member Functions
HD_API	HdFlatteningSceneIndex (HdSceneIndexBaseRefPtr const &inputScene, HdContainerDataSourceHandle const &inputArgs)

void	_PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override

void	_PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override

void	_PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) 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

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

Additional Inherited Members
Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr )(TfRefBase const *, bool)

Detailed Description

A scene index that observes an input scene index and produces a comparable scene in which inherited state is represented at leaf prims.

This kind of representation is useful for render delegates that require some/all the information to be available at the leaf prims. It is also useful to express scene description composition functionality (e.g., material binding resolution that factors inherited opinions) via flattened data source provider(s).

Definition at line 62 of file flatteningSceneIndex.h.

Constructor & Destructor Documentation

HD_API HdFlatteningSceneIndex::~HdFlatteningSceneIndex ( )

override

HD_API HdFlatteningSceneIndex::HdFlatteningSceneIndex	(	HdSceneIndexBaseRefPtr const &	inputScene,
		HdContainerDataSourceHandle const &	inputArgs
	)

protected

Member Function Documentation

void HdFlatteningSceneIndex::_PrimsAdded	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::AddedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdFlatteningSceneIndex::_PrimsDirtied	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::DirtiedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

void HdFlatteningSceneIndex::_PrimsRemoved	(	const HdSceneIndexBase &	sender,
		const HdSceneIndexObserver::RemovedPrimEntries &	entries
	)

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

const TfTokenVector& HdFlatteningSceneIndex::GetFlattenedDataSourceNames ( ) const

inline

Data sources under locator name in a prim source get flattened.

Definition at line 89 of file flatteningSceneIndex.h.

const HdFlattenedDataSourceProviderSharedPtrVector& HdFlatteningSceneIndex::GetFlattenedDataSourceProviders ( ) const

inline

Providers in the same order as GetFlattenedDataSourceNames.

Definition at line 95 of file flatteningSceneIndex.h.

HD_API HdSceneIndexPrim HdFlatteningSceneIndex::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 HdFlatteningSceneIndexRefPtr HdFlatteningSceneIndex::New	(	HdSceneIndexBaseRefPtr const &	inputScene,
		HdContainerDataSourceHandle const &	inputArgs
	)

inlinestatic

Creates a new flattening scene index. inputArgs maps names to HdFlattenedDataSourceProviderSharedPtr's. That provider flattens the data sources under the locator name in each prim source.

Definition at line 70 of file flatteningSceneIndex.h.

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

pxr/imaging/hd/flatteningSceneIndex.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation