#include <materialRenderContextFilteringSceneIndex.h>

Inheritance diagram for HdsiMaterialRenderContextFilteringSceneIndex:

Public Types
using	TypePredicateFn = std::function< bool(const TfToken &)>

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

Public Member Functions
HDSI_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override

HDSI_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override

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 HDSI_API HdsiMaterialRenderContextFilteringSceneIndexRefPtr	New (const HdSceneIndexBaseRefPtr &inputSceneIndex, TfTokenVector renderContextPriorityOrder, TypePredicateFn typePredicateFn)

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

Protected Member Functions
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

	HdsiMaterialRenderContextFilteringSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex, TfTokenVector renderContextPriorityOrder, TypePredicateFn typePredicateFn)

	~HdsiMaterialRenderContextFilteringSceneIndex () 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

Detailed Description

Scene Index that filters the render contexts available for the data source at the 'material' locator of a prim to the first render context encountered in renderContextPriorityOrder, a vector of render context names in descending order of preference, provided at construction time. If no such render context is found, all render contexts are filtered out.

Since material networks may be authored for non-material prims (e.g. lights) a predicate function may be provided at construction time via typePredicateFn to restrict filtering to only those prim types for which the predicate returns true. If no predicate function is provided, filtering is applied to all prims.

Hydra renderers will typically instantiate this scene index via the scene index plugin registration facility to filter in material networks for render contexts they support.

Note: In the Hydra 1.0 API, the render delegate provides the list of supported render contexts via HdRenderDelegate::GetMaterialRenderContexts(). This scene index provides a way to express this opinion for filtering purposes, so that downstream scene indices that modify the material network don't need to concern themselves about multiple render contexts.

This functionality is currently implemented in the HdSceneIndexAdapterSceneDelegate (backend emulation).

Definition at line 46 of file materialRenderContextFilteringSceneIndex.h.

Member Typedef Documentation

using HdsiMaterialRenderContextFilteringSceneIndex::TypePredicateFn = std::function<bool(const TfToken&)>

Definition at line 50 of file materialRenderContextFilteringSceneIndex.h.

Constructor & Destructor Documentation

HdsiMaterialRenderContextFilteringSceneIndex::HdsiMaterialRenderContextFilteringSceneIndex	(	const HdSceneIndexBaseRefPtr &	inputSceneIndex,
		TfTokenVector	renderContextPriorityOrder,
		TypePredicateFn	typePredicateFn
	)

protected

HdsiMaterialRenderContextFilteringSceneIndex::~HdsiMaterialRenderContextFilteringSceneIndex ( )

overrideprotected

Member Function Documentation

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

HDSI_API SdfPathVector HdsiMaterialRenderContextFilteringSceneIndex::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.

HDSI_API HdSceneIndexPrim HdsiMaterialRenderContextFilteringSceneIndex::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.

static HDSI_API HdsiMaterialRenderContextFilteringSceneIndexRefPtr HdsiMaterialRenderContextFilteringSceneIndex::New	(	const HdSceneIndexBaseRefPtr &	inputSceneIndex,
		TfTokenVector	renderContextPriorityOrder,
		TypePredicateFn	typePredicateFn
	)

static

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

pxr/imaging/hdsi/materialRenderContextFilteringSceneIndex.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation