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

#include <rerootingSceneIndex.h>

+ Inheritance diagram for UsdImagingRerootingSceneIndex:

Public Member Functions

USDIMAGING_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 
USDIMAGING_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 
- 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

static
UsdImagingRerootingSceneIndexRefPtr 
New (HdSceneIndexBaseRefPtr const &inputScene, const SdfPath &srcPrefix, const SdfPath &dstPrefix)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

USDIMAGING_API UsdImagingRerootingSceneIndex (HdSceneIndexBaseRefPtr const &inputScene, const SdfPath &srcPrefix, const SdfPath &dstPrefix)
 
USDIMAGING_API ~UsdImagingRerootingSceneIndex () override
 
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

UsdImagingRerootingSceneIndex

Drops all prims not under srcPrefix and moves those under srcPrefix to dstPrefix.

Data sources containing paths will be updated accordingly. That is, if it contains a path with srcPrefix as prefix, the prefix will be replaced by dstPrefix.

Note that this can be used as prefixing scene index by setting srcPrefix to the root path. It can also use to isolate part of the namespace by setting the srcPrefix and dstPrefix to be equal.

Definition at line 48 of file rerootingSceneIndex.h.

Constructor & Destructor Documentation

USDIMAGING_API UsdImagingRerootingSceneIndex::UsdImagingRerootingSceneIndex ( HdSceneIndexBaseRefPtr const &  inputScene,
const SdfPath srcPrefix,
const SdfPath dstPrefix 
)
protected
USDIMAGING_API UsdImagingRerootingSceneIndex::~UsdImagingRerootingSceneIndex ( )
overrideprotected

Member Function Documentation

void UsdImagingRerootingSceneIndex::_PrimsAdded ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::AddedPrimEntries entries 
)
overrideprotectedvirtual
void UsdImagingRerootingSceneIndex::_PrimsDirtied ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::DirtiedPrimEntries entries 
)
overrideprotectedvirtual
void UsdImagingRerootingSceneIndex::_PrimsRemoved ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::RemovedPrimEntries entries 
)
overrideprotectedvirtual
USDIMAGING_API SdfPathVector UsdImagingRerootingSceneIndex::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.

USDIMAGING_API HdSceneIndexPrim UsdImagingRerootingSceneIndex::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 UsdImagingRerootingSceneIndexRefPtr UsdImagingRerootingSceneIndex::New ( HdSceneIndexBaseRefPtr const &  inputScene,
const SdfPath srcPrefix,
const SdfPath dstPrefix 
)
inlinestatic

Definition at line 52 of file rerootingSceneIndex.h.


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