#include <sceneIndex.h>

Inheritance diagram for HdSceneIndexBase:

Public Member Functions
HD_API	HdSceneIndexBase ()

HD_API	~HdSceneIndexBase () override

HD_API void	AddObserver (const HdSceneIndexObserverPtr &observer)

HD_API void	RemoveObserver (const HdSceneIndexObserverPtr &observer)

virtual HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const =0

virtual SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const =0

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

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

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

Detailed Description

Abstract interface to scene data. This class can be queried for scene data directly, and it can also register observers to be notified about scene changes (see HdSceneIndexObserver).

Definition at line 54 of file sceneIndex.h.

Constructor & Destructor Documentation

HD_API HdSceneIndexBase::HdSceneIndexBase ( )

HD_API HdSceneIndexBase::~HdSceneIndexBase ( )

override

Member Function Documentation

HD_API bool HdSceneIndexBase::_IsObserved ( ) const

protected

Returns whether the scene index has any registered observers; this information can be used to skip work preparing notices when there are no observers.

HD_API void HdSceneIndexBase::_SendPrimsAdded ( const HdSceneIndexObserver::AddedPrimEntries & entries )

protected

Notify attached observers of prims added to the scene. The set of scene prims compiled from added/removed notices should match the set from a traversal based on GetChildPrimPaths. Each prim has a path and type. It's possible for PrimsAdded to be called for prims that already exist; in that case, observers should be sure to update the prim type, in case it changed, and resync the prim. This function is not threadsafe; some observers expect it to be called from a single thread.

HD_API void HdSceneIndexBase::_SendPrimsDirtied ( const HdSceneIndexObserver::DirtiedPrimEntries & entries )

protected

Notify attached observers of datasource invalidations from the scene. This message is not considered hierarchical on primPath; if /Path is dirtied, /Path/child is not necessarily dirtied. However, locators are considered hierarchical: if primvars is dirtied on a prim, primvars/color is considered dirtied as well. This function is not threadsafe; some observers expect it to be called from a single thread.

HD_API void HdSceneIndexBase::_SendPrimsRemoved ( const HdSceneIndexObserver::RemovedPrimEntries & entries )

protected

Notify attached observers of prims removed from the scene. Note that this message is considered hierarchical: if /Path is removed, /Path/child is considered removed as well. This function is not threadsafe; some observers expect it to be called from a single thread.

HD_API void HdSceneIndexBase::_SendPrimsRenamed ( const HdSceneIndexObserver::RenamedPrimEntries & entries )

protected

Notify attached observers of prims (and their descendents) which have been renamed or reparented. This function is not threadsafe; some observers expect it to be called from a single thread.

virtual HD_API void HdSceneIndexBase::_SystemMessage	(	const TfToken &	messageType,
		const HdDataSourceBaseHandle &	args
	)

protectedvirtual

Implement in order to react directly to system messages sent from downstream.

Reimplemented in HdGpGenerativeProceduralResolvingSceneIndex.

HD_API void HdSceneIndexBase::AddObserver ( const HdSceneIndexObserverPtr & observer )

Adds an observer to this scene index. The given observer will be sent notices for prims added, removed, or dirtied after it is added as an observer. It will not be sent notices for prims already in the scene index; the calling code is responsible for updating observer state if the scene index has already been populated. This function is not threadsafe.

HD_API void HdSceneIndexBase::AddTag ( const TfToken & tag )

Adds a specified tag token to a scene index instance. This is in service of user interfaces which want to filter views of a scene index chain or graph.

virtual SdfPathVector HdSceneIndexBase::GetChildPrimPaths ( const SdfPath & primPath ) const

pure virtual

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.

HdDataSourceBaseHandle HdSceneIndexBase::GetDataSource	(	const SdfPath &	primPath,
		const HdDataSourceLocator &	locator
	)		const

inline

A convenience function: look up the object at primPath, and if successful return the datasource at locator within that prim. This is equivalent to calling GetPrim(primPath), and then calling HdContainerDataSource::Get(prim.dataSource, locator).

Definition at line 116 of file sceneIndex.h.

HD_API std::string HdSceneIndexBase::GetDisplayName ( ) const

Returns a value previously set by SetDisplayName. If no value (or an empty string) was last set, this returns a symbol-demangled version of the class type itself. This is in service of user interfaces with views of scene index chains or graphs.

virtual HdSceneIndexPrim HdSceneIndexBase::GetPrim ( const SdfPath & primPath ) const

pure virtual

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.

HD_API TfTokenVector HdSceneIndexBase::GetTags ( ) const

Returns all tag tokens currently added to a scene index instance. This is in service of user interfaces which want to filter views of a scene index chain or graph.

HD_API bool HdSceneIndexBase::HasTag ( const TfToken & tag ) const

Returns true if a specified tag token has been added to a scene index instance. This is in service of user interfaces which want to filter views of a scene index chain or graph.

HD_API void HdSceneIndexBase::RemoveObserver ( const HdSceneIndexObserverPtr & observer )

Removes an observer from this scene index; the given observer will no longer be forwarded notices. Note that the observer won't get any notices as a result of being detached from this scene index. If observer is not registered on this scene index, this call does nothing. This function is not threadsafe.

HD_API void HdSceneIndexBase::RemoveTag ( const TfToken & tag )

Removes a specified tag token to a scene index instance. This is in service of user interfaces which want to filter views of a scene index chain or graph.

HD_API void HdSceneIndexBase::SetDisplayName ( const std::string & n )

Allows for scene index instances to be identified in a more contextually relevant way. This is in service of user interfaces with views of scene index chains or graphs.

HD_API void HdSceneIndexBase::SystemMessage	(	const TfToken &	messageType,
		const HdDataSourceBaseHandle &	args
	)

Sends a message with optional arguments to this and any upstream input scene indices. Scene indices may implement _SystemMessage to provide custom handling. See systemMessages.h for common message definitions.

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

pxr/imaging/hd/sceneIndex.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation