![]() |
|
An interface for initial scene indices that populate the Hydra scene with prims and data sources from a UsdStage. More...
#include <stageSceneIndexInterface.h>
Inheritance diagram for UsdImagingStageSceneIndexInterface:Public Member Functions | |
| virtual void | SetStage (UsdStageRefPtr stage)=0 |
| Set the USD stage to pull data from. | |
| virtual void | SetTime (UsdTimeCode time)=0 |
| Set the time, and call PrimsDirtied for any time-varying attributes. | |
| virtual UsdTimeCode | GetTime () const =0 |
| Return the current time. | |
| virtual void | ApplyPendingUpdates ()=0 |
| Apply queued stage edits to imaging scene. | |
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. | |
| virtual HdSceneIndexPrim | GetPrim (const SdfPath &primPath) const =0 |
| Returns a pair of (prim type, datasource). | |
| virtual SdfPathVector | GetChildPrimPaths (const SdfPath &primPath) const =0 |
| Returns the paths of all scene index prims located immediately below primPath. | |
| 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 |
Additional Inherited Members | |
Public Types inherited from TfRefBase | |
| typedef void(*) | UniqueChangedFuncPtr(TfRefBase const *, bool) |
Static Public Member Functions inherited from TfRefBase | |
| static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
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 |
An interface for initial scene indices that populate the Hydra scene with prims and data sources from a UsdStage.
Definition at line 31 of file stageSceneIndexInterface.h.
|
pure virtual |
Apply queued stage edits to imaging scene.
If the USD stage is edited while the scene index is pulling from it, those edits get queued and deferred. Calling ApplyPendingUpdates will turn resync requests into PrimsAdded/PrimsRemoved, and property changes into PrimsDirtied.
Implemented in UsdImagingStageSceneIndex.
|
pure virtual |
Return the current time.
Implemented in UsdImagingStageSceneIndex.
|
pure virtual |
Set the USD stage to pull data from.
Note that this will delete all scene index prims and reset stage global data.
Implemented in UsdImagingStageSceneIndex.
|
pure virtual |
Set the time, and call PrimsDirtied for any time-varying attributes.
PrimsDirtied is only called if the time is different from the last call.
Implemented in UsdImagingStageSceneIndex.