HdsiSwitchingSceneIndex Class Reference

#include <switchingSceneIndex.h>

Inheritance diagram for HdsiSwitchingSceneIndex:

Public Types
using	ComputeDiffFn = HdsiComputeSceneIndexDiff
Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr )(TfRefBase const *, bool)

Public Member Functions
HDSI_API size_t	GetIndex () const
	Returns the current index. More...
HDSI_API void	SetIndex (size_t index)
HDSI_API std::vector < HdSceneIndexBaseRefPtr >	GetInputScenes () const override
HDSI_API HdSceneIndexPrim	GetPrim (const SdfPath &primPath) const override
HDSI_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 HdsiSwitchingSceneIndexRefPtr	New (const std::vector< HdSceneIndexBaseRefPtr > &inputs, size_t initialIndex=0, ComputeDiffFn computeDiffFn=HdsiComputeSceneIndexDiffDelta)
Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Protected Member Functions
HDSI_API	HdsiSwitchingSceneIndex (const std::vector< HdSceneIndexBaseRefPtr > &inputs, size_t initialIndex, ComputeDiffFn computeDiffFn)
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

Friends
class	_Observer

Detailed Description

This is a scene index that can switch between multiple inputs (which are fixed at construction time).

By default, this scene index will use HdsiComputeSceneIndexDelta to compute notices to send when the index is changed. If you know more about the input scenes, you can likely provide a more efficient/specialized one.

Definition at line 26 of file switchingSceneIndex.h.

Member Typedef Documentation

using HdsiSwitchingSceneIndex::ComputeDiffFn = HdsiComputeSceneIndexDiff

Definition at line 29 of file switchingSceneIndex.h.

Constructor & Destructor Documentation

HDSI_API HdsiSwitchingSceneIndex::HdsiSwitchingSceneIndex ( const std::vector< HdSceneIndexBaseRefPtr > &  inputs, size_t  initialIndex, ComputeDiffFn  computeDiffFn  )

protected

Member Function Documentation

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

Implements HdSceneIndexBase.

HDSI_API size_t HdsiSwitchingSceneIndex::GetIndex

(

)

const

Returns the current index.

HDSI_API std::vector<HdSceneIndexBaseRefPtr> HdsiSwitchingSceneIndex::GetInputScenes ( ) const

overridevirtual

Implements HdFilteringSceneIndexBase.

HDSI_API HdSceneIndexPrim HdsiSwitchingSceneIndex::GetPrim ( const SdfPath &  primPath ) const

overridevirtual

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.

Implements HdSceneIndexBase.

static HdsiSwitchingSceneIndexRefPtr HdsiSwitchingSceneIndex::New ( const std::vector< HdSceneIndexBaseRefPtr > &  inputs, size_t  initialIndex = 0, ComputeDiffFn  computeDiffFn = HdsiComputeSceneIndexDiffDelta  )

inlinestatic

Definition at line 32 of file switchingSceneIndex.h.

HDSI_API void HdsiSwitchingSceneIndex::SetIndex

(

size_t

index

)

Sets the current index.

Index must be in [0, GetInputScenes().size()).

Friends And Related Function Documentation

friend class _Observer

friend

Definition at line 88 of file switchingSceneIndex.h.

---

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

• pxr/imaging/hdsi/switchingSceneIndex.h