All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdImagingSelectionSceneIndex Class Referencefinal

#include <selectionSceneIndex.h>

+ Inheritance diagram for UsdImagingSelectionSceneIndex:

Public Member Functions

 ~UsdImagingSelectionSceneIndex () override
USDIMAGING_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
USDIMAGING_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
USDIMAGING_API void AddSelection (const SdfPath &usdPath)
USDIMAGING_API void ClearSelection ()
 Reset the scene index selection state. More...
- Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API std::vector
< HdSceneIndexBaseRefPtr > 
GetInputScenes () const final
- 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 &)
TfRefBaseoperator= (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 TfWeakBaseoperator= (const TfWeakBase &)
void EnableNotification2 () const
TF_API void const * GetUniqueIdentifier () const

Static Public Member Functions

New (HdSceneIndexBaseRefPtr const &inputSceneIndex)
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)

Protected Member Functions

void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override
void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override
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
- 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

Additional Inherited Members

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

Detailed Description

A simple scene index adding HdSelectionsSchema to all prims selected with AddSelection.

Definition at line 45 of file selectionSceneIndex.h.

Constructor & Destructor Documentation

UsdImagingSelectionSceneIndex::~UsdImagingSelectionSceneIndex ( )

Member Function Documentation

void UsdImagingSelectionSceneIndex::_PrimsAdded ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::AddedPrimEntries entries 
void UsdImagingSelectionSceneIndex::_PrimsDirtied ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::DirtiedPrimEntries entries 
void UsdImagingSelectionSceneIndex::_PrimsRemoved ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::RemovedPrimEntries entries 
USDIMAGING_API void UsdImagingSelectionSceneIndex::AddSelection ( const SdfPath usdPath)

Given a path (including usd proxy path inside a native instance) of a USD prim, determine the corresponding prim in the Usd scene index (filtered by the UsdImagingNiPrototypePropagatingSceneIndex) and populate its selections data source.

USDIMAGING_API void UsdImagingSelectionSceneIndex::ClearSelection ( )

Reset the scene index selection state.

USDIMAGING_API SdfPathVector UsdImagingSelectionSceneIndex::GetChildPrimPaths ( const SdfPath primPath) const

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.

USDIMAGING_API HdSceneIndexPrim UsdImagingSelectionSceneIndex::GetPrim ( const SdfPath primPath) const

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 USDIMAGING_API UsdImagingSelectionSceneIndexRefPtr UsdImagingSelectionSceneIndex::New ( HdSceneIndexBaseRefPtr const &  inputSceneIndex)

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