#include <retainedSceneIndex.h>

Inheritance diagram for HdRetainedSceneIndex:

Classes
struct	AddedPrimEntry

Public Types
using	AddedPrimEntries = std::vector< AddedPrimEntry >

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

Public Member Functions
virtual HD_API void	AddPrims (const AddedPrimEntries &entries)

virtual HD_API void	RemovePrims (const HdSceneIndexObserver::RemovedPrimEntries &entries)

virtual HD_API void	DirtyPrims (const HdSceneIndexObserver::DirtiedPrimEntries &entries)

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 HD_API HdRetainedSceneIndexRefPtr	New ()
	Creates a new retained scene index. More...

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

Protected Member Functions
HD_API	HdRetainedSceneIndex ()

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

Concrete scene container which can be externally populated and dirtied.

Definition at line 43 of file retainedSceneIndex.h.

Member Typedef Documentation

using HdRetainedSceneIndex::AddedPrimEntries = std::vector<AddedPrimEntry>

Definition at line 62 of file retainedSceneIndex.h.

Constructor & Destructor Documentation

HD_API HdRetainedSceneIndex::HdRetainedSceneIndex ( )

protected

Member Function Documentation

virtual HD_API void HdRetainedSceneIndex::AddPrims ( const AddedPrimEntries & entries )

virtual

Add a prim to the retained scene index. Each added entry has a path, type, and datasource; the retained scene index assumes ownership of these and uses them to answer scene queries. This will also generate a PrimsAdded notification, if applicable.

virtual HD_API void HdRetainedSceneIndex::DirtyPrims ( const HdSceneIndexObserver::DirtiedPrimEntries & entries )

virtual

Invalidates prim data in the retained scene index. This scene index doesn't have any internal invalidation mechanisms, but it generates a PrimsDirtied notification, if applicable. Subclasses can use it for invalidation of caches or retained data.

Reimplemented in HdLegacyPrimSceneIndex.

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

HD_API HdSceneIndexPrim HdRetainedSceneIndex::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 HD_API HdRetainedSceneIndexRefPtr HdRetainedSceneIndex::New ( )

inlinestatic

Creates a new retained scene index.

Definition at line 49 of file retainedSceneIndex.h.

virtual HD_API void HdRetainedSceneIndex::RemovePrims ( const HdSceneIndexObserver::RemovedPrimEntries & entries )

virtual

Removes a prim subtree from the retained scene index. This will also generate a PrimsRemoved notification, if applicable.

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

pxr/imaging/hd/retainedSceneIndex.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation