Concrete scene container which can be externally populated and dirtied. More...

#include <retainedSceneIndex.h>

Inheritance diagram for HdRetainedSceneIndex:

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)
	Add a prim to the retained scene index.

virtual HD_API void	RemovePrims (const HdSceneIndexObserver::RemovedPrimEntries &entries)
	Removes a prim subtree from the retained scene index.

virtual HD_API void	DirtyPrims (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
	Invalidates prim data in the retained scene index.

HD_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override
	Returns a pair of (prim type, datasource) for the object at `primPath`.

HD_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override
	Returns the paths of all scene index prims located immediately below `primPath`.

Public Member Functions inherited from HdSceneIndexBase
HD_API void	AddObserver (const HdSceneIndexObserverPtr &observer)
	Adds an observer to this scene index.

HD_API void	RemoveObserver (const HdSceneIndexObserverPtr &observer)
	Removes an observer from this scene index; the given observer will no longer be forwarded notices.

virtual HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const =0
	Returns a pair of (prim type, datasource) for the object at `primPath`.

virtual SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const =0
	Returns the paths of all scene index prims located immediately below `primPath`.

HdDataSourceBaseHandle	GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const
	A convenience function: look up the object at `primPath`, and if successful return the datasource at `locator` within that prim.

HD_API void	SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
	Sends a message with optional arguments to this and any upstream input scene indices.

HD_API std::string	GetDisplayName () const
	Returns a value previously set by SetDisplayName.

HD_API void	SetDisplayName (const std::string &n)
	Allows for scene index instances to be identified in a more contextually relevant way.

HD_API void	AddTag (const TfToken &tag)
	Adds a specified tag token to a scene index instance.

HD_API void	RemoveTag (const TfToken &tag)
	Removes a specified tag token to a scene index instance.

HD_API bool	HasTag (const TfToken &tag) const
	Returns true if a specified tag token has been added to a scene index instance.

HD_API TfTokenVector	GetTags () const
	Returns all tag tokens currently added to a scene index instance.

Public Member Functions inherited from TfRefBase
	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

size_t	GetCurrentCount () const
	Return the current reference count of this object.

bool	IsUnique () const
	Return true if only one `TfRefPtr` points to this object.

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from 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.

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

Additional Inherited Members
Protected Member Functions inherited from HdSceneIndexBase
HD_API void	_SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)
	Notify attached observers of prims added to the scene.

HD_API void	_SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)
	Notify attached observers of prims removed from the scene.

HD_API void	_SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
	Notify attached observers of datasource invalidations from the scene.

HD_API void	_SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries)
	Notify attached observers of prims (and their descendents) which have been renamed or reparented.

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

virtual HD_API void	_SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
	Implement in order to react directly to system messages sent from downstream.

Protected Member Functions inherited from 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 26 of file retainedSceneIndex.h.

Member Typedef Documentation

◆ AddedPrimEntries

using AddedPrimEntries = std::vector<AddedPrimEntry>

Definition at line 45 of file retainedSceneIndex.h.

Member Function Documentation

◆ AddPrims()

virtual HD_API void 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.

◆ DirtyPrims()

virtual HD_API void 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.

◆ GetChildPrimPaths()

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

◆ GetPrim()

HD_API HdSceneIndexPrim 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.

◆ New()

static HD_API HdRetainedSceneIndexRefPtr New ( )

inlinestatic

Creates a new retained scene index.

Definition at line 32 of file retainedSceneIndex.h.

◆ RemovePrims()

virtual HD_API void 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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ AddedPrimEntries

Member Function Documentation

◆ AddPrims()

◆ DirtyPrims()

◆ GetChildPrimPaths()

◆ GetPrim()

◆ New()

◆ RemovePrims()