 |
|
|
|
Applies a bijective namespace mapping, as represented by a PcpMapFunction, to the input namespace. More...
#include <rerootingSceneIndex.h>
Inheritance diagram for UsdImagingRerootingSceneIndex:Public Member Functions | |
| USDIMAGING_API HdSceneIndexPrim | GetPrim (const SdfPath &primPath) const override |
| Returns a pair of (prim type, datasource). | |
| USDIMAGING_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 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 UsdImagingRerootingSceneIndexRefPtr | New (HdSceneIndexBaseRefPtr const &inputScene, const SdfPath &srcPrefix, const SdfPath &dstPrefix) |
| A convenience method that maps between two provided paths. | |
| static UsdImagingRerootingSceneIndexRefPtr | New (HdSceneIndexBaseRefPtr const &inputScene, PcpMapFunction const &mapFn) |
| Static Public Member Functions inherited from TfRefBase | |
| static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
Protected Member Functions | |
| USDIMAGING_API | UsdImagingRerootingSceneIndex (HdSceneIndexBaseRefPtr const &inputScene, PcpMapFunction const &mapFn) |
| 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 |
| 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) |
Applies a bijective namespace mapping, as represented by a PcpMapFunction, to the input namespace.
Data sources containing paths will be updated accordingly. That is, the namespace mapping function will be applied to path-valued data.
Note that this can be used as prefixing scene index by mapping a path to the root path. It can also use to isolate part of the namespace by using a namespace mapping that maps a specific path to itself but does not include a root identity mapping. See PcpMapFunction for more. The SdfLayerOffset component of the path mapping is not applied.
Definition at line 34 of file rerootingSceneIndex.h.
|
overrideprotectedvirtual |
Implements HdSingleInputFilteringSceneIndexBase.
|
overrideprotectedvirtual |
Implements HdSingleInputFilteringSceneIndexBase.
|
overrideprotectedvirtual |
Implements HdSingleInputFilteringSceneIndexBase.
|
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.
|
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.
|
inlinestatic |
A convenience method that maps between two provided paths.
Definition at line 39 of file rerootingSceneIndex.h.
|
inlinestatic |
Definition at line 51 of file rerootingSceneIndex.h.
1.12.0 