#include <primTypeAndPathPruningSceneIndex.h>

Inheritance diagram for HdsiPrimTypeAndPathPruningSceneIndex:

Public Types
using	PathPredicate = std::function< bool(const SdfPath &)>

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

Public Member Functions
HDSI_API void	SetPathPredicate (PathPredicate pathPredicate)

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

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

Protected Member Functions
HDSI_API void	_PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override

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

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

HDSI_API	HdsiPrimTypeAndPathPruningSceneIndex (HdSceneIndexBaseRefPtr const &inputSceneIndex, HdContainerDataSourceHandle const &inputArgs)

HDSI_API	~HdsiPrimTypeAndPathPruningSceneIndex () 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 prunes prims if its type is in a given list and its path matches a given predicate.

Pruned prims are not removed from the scene index; instead, they are given an empty primType and null dataSource. This is to preserve hierarchy and allow children of the pruned types to still exist.

By default, the predicate is empty (empty std::function) and no prims will be pruned.

Definition at line 35 of file primTypeAndPathPruningSceneIndex.h.

Member Typedef Documentation

using HdsiPrimTypeAndPathPruningSceneIndex::PathPredicate = std::function<bool(const SdfPath &)>

Definition at line 44 of file primTypeAndPathPruningSceneIndex.h.

Constructor & Destructor Documentation

HDSI_API HdsiPrimTypeAndPathPruningSceneIndex::HdsiPrimTypeAndPathPruningSceneIndex	(	HdSceneIndexBaseRefPtr const &	inputSceneIndex,
		HdContainerDataSourceHandle const &	inputArgs
	)

protected

HDSI_API HdsiPrimTypeAndPathPruningSceneIndex::~HdsiPrimTypeAndPathPruningSceneIndex ( )

overrideprotected

Member Function Documentation

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

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

HDSI_API HdSceneIndexPrim HdsiPrimTypeAndPathPruningSceneIndex::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 HDSI_API HdsiPrimTypeAndPathPruningSceneIndexRefPtr HdsiPrimTypeAndPathPruningSceneIndex::New	(	HdSceneIndexBaseRefPtr const &	inputSceneIndex,
		HdContainerDataSourceHandle const &	inputArgs
	)

static

HDSI_API void HdsiPrimTypeAndPathPruningSceneIndex::SetPathPredicate ( PathPredicate pathPredicate )

Set predicate returning true if a prim at a particular path should be pruned. Setting to an empty predicate means that no prim will be pruned.

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

pxr/imaging/hdsi/primTypeAndPathPruningSceneIndex.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation