A scene index that provides a topological view of the scene as though instancing were not being used. More...

#include <instanceProxyViewSceneIndex.h>

Inheritance diagram for HdInstanceProxyViewSceneIndex:

Public Member Functions
HD_API bool	IsInstanceProxy (const SdfPath &primPath) const
	Returns true if the given prim path is an instance proxy prim path matching the USD definition of an instance proxy prim.

HD_API bool	IsOutermostInstance (const SdfPath &primPath) const
	Returns true if the given prim path is a leaf instance prim path that isn't under an instancer prim.

HD_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override
	Adds support for instance proxy prim paths.

HD_API SdfPathVector	GetChildPrimPaths (const SdfPath &primPath) const override
	Adds support for queries on outer (leaf) instance prim paths and instance proxy prim paths.

Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API std::vector< HdSceneIndexBaseRefPtr >	GetInputScenes () const final

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

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 HdInstanceProxyViewSceneIndexRefPtr	New (const HdSceneIndexBaseRefPtr &inputSceneIndex)

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

Protected Member Functions
HD_API	HdInstanceProxyViewSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex)

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

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

HD_API void	_PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) 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
	Returns the input scene.

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

Detailed Description

A scene index that provides a topological view of the scene as though instancing were not being used.

Specifically, this scene index "unrolls" leaf instance prims (i.e. prims with an instance data source that aren't under an instancer prim) by providing "instance proxy" prims as descendants. These instance proxy prims mirror the structure of the corresponding instance prim's prototype subtree. Each instance proxy prim mirrors the corresponding prototype's prim type and prim container with the addition of an instanceProxy data source that provides the path to the mirrored prototype prim.

The resulting scene index view is useful for path expression-based collection membership evaluation, and for UI tools like the Hydra Scene Debugger.

Note: This scene index does not currently send any notices for instance proxy prims. It is not intended for use in a scene index pipeline chain.; This scene index unrolls implicit instancing (e.g. USD native instancing). It does not unroll explicit instancing (e.g. point instancers).

Definition at line 48 of file instanceProxyViewSceneIndex.h.

Member Function Documentation

◆ _PrimsAdded()

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

◆ _PrimsDirtied()

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

◆ _PrimsRemoved()

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

overrideprotectedvirtual

Implements HdSingleInputFilteringSceneIndexBase.

◆ GetChildPrimPaths()

HD_API SdfPathVector GetChildPrimPaths ( const SdfPath & primPath ) const

overridevirtual

Adds support for queries on outer (leaf) instance prim paths and instance proxy prim paths.

Forwards other queries to the input scene index.

Implements HdSceneIndexBase.

◆ GetPrim()

HD_API HdSceneIndexPrim GetPrim ( const SdfPath & primPath ) const

overridevirtual

Adds support for instance proxy prim paths.

Forwards other queries to the input scene index.

Implements HdSceneIndexBase.

◆ IsInstanceProxy()

HD_API bool IsInstanceProxy ( const SdfPath & primPath ) const

Returns true if the given prim path is an instance proxy prim path matching the USD definition of an instance proxy prim.

◆ IsOutermostInstance()

HD_API bool IsOutermostInstance ( const SdfPath & primPath ) const

Returns true if the given prim path is a leaf instance prim path that isn't under an instancer prim.

In USD parlance, this is the outermost UsdPrim for which prim.IsInstance() is true and prim.IsInstanceProxy() is false.

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

pxr/imaging/hd/instanceProxyViewSceneIndex.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _PrimsAdded()

◆ _PrimsDirtied()

◆ _PrimsRemoved()

◆ GetChildPrimPaths()

◆ GetPrim()

◆ IsInstanceProxy()

◆ IsOutermostInstance()