|
Abstract interface to scene data. More...
#include <sceneIndex.h>
Public Member Functions | |
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) for the object at primPath . | |
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 |
Protected Member Functions | |
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 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) |
Static Public Member Functions inherited from TfRefBase | |
static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
Abstract interface to scene data.
This class can be queried for scene data directly, and it can also register observers to be notified about scene changes (see HdSceneIndexObserver).
Definition at line 47 of file sceneIndex.h.
|
protected |
Returns whether the scene index has any registered observers; this information can be used to skip work preparing notices when there are no observers.
|
protected |
Notify attached observers of prims added to the scene.
The set of scene prims compiled from added/removed notices should match the set from a traversal based on GetChildPrimNames
. Each prim has a path and type. It's possible for PrimsAdded
to be called for prims that already exist; in that case, observers should be sure to update the prim type, in case it changed, and resync the prim. This function is not threadsafe; some observers expect it to be called from a single thread.
|
protected |
Notify attached observers of datasource invalidations from the scene.
This message is not considered hierarchical on primPath
; if /Path
is dirtied, /Path/child
is not necessarily dirtied. However, locators are considered hierarchical: if primvars
is dirtied on a prim, primvars/color
is considered dirtied as well. This function is not threadsafe; some observers expect it to be called from a single thread.
|
protected |
Notify attached observers of prims removed from the scene.
Note that this message is considered hierarchical: if /Path
is removed, /Path/child
is considered removed as well. This function is not threadsafe; some observers expect it to be called from a single thread.
|
protected |
Notify attached observers of prims (and their descendents) which have been renamed or reparented.
This function is not threadsafe; some observers expect it to be called from a single thread.
|
protectedvirtual |
Implement in order to react directly to system messages sent from downstream.
Reimplemented in HdGpGenerativeProceduralResolvingSceneIndex.
HD_API void AddObserver | ( | const HdSceneIndexObserverPtr & | observer | ) |
Adds an observer to this scene index.
The given observer will be sent notices for prims added, removed, or dirtied after it is added as an observer. It will not be sent notices for prims already in the scene index; the calling code is responsible for updating observer state if the scene index has already been populated. This function is not threadsafe.
HD_API void AddTag | ( | const TfToken & | tag | ) |
Adds a specified tag token to a scene index instance.
This is in service of user interfaces which want to filter views of a scene index chain or graph.
|
pure virtual |
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.
Implemented in HdFlatteningSceneIndex, HdLegacyGeomSubsetSceneIndex, HdMergingSceneIndex, HdPrefixingSceneIndex, HdRetainedSceneIndex, HdGpGenerativeProceduralFilteringSceneIndex, HdGpGenerativeProceduralResolvingSceneIndex, HdsiCoordSysPrimSceneIndex, HdsiExtComputationDependencySceneIndex, HdsiImplicitSurfaceSceneIndex, HdsiLegacyDisplayStyleOverrideSceneIndex, HdsiLightLinkingSceneIndex, HdsiMaterialBindingResolvingSceneIndex, HdsiMaterialPrimvarTransferSceneIndex, HdsiNurbsApproximatingSceneIndex, HdsiPrimTypeAndPathPruningSceneIndex, HdsiPrimTypeNoticeBatchingSceneIndex, HdsiPrimTypePruningSceneIndex, HdsiRenderSettingsFilteringSceneIndex, HdsiSwitchingSceneIndex, HdsiTetMeshConversionSceneIndex, UsdImagingDrawModeSceneIndex, UsdImagingExtentResolvingSceneIndex, UsdImagingMaterialBindingsResolvingSceneIndex, UsdImagingNiPrototypePropagatingSceneIndex, UsdImagingPiPrototypePropagatingSceneIndex, UsdImagingRenderSettingsFlatteningSceneIndex, UsdImagingRerootingSceneIndex, UsdImagingRootOverridesSceneIndex, UsdImagingSelectionSceneIndex, UsdImagingUnloadedDrawModeSceneIndex, HdMaterialFilteringSceneIndexBase, HdSiExtComputationPrimvarPruningSceneIndex, HdsiPinnedCurveExpandingSceneIndex, and HdsiSceneGlobalsSceneIndex.
|
inline |
A convenience function: look up the object at primPath
, and if successful return the datasource at locator
within that prim.
This is equivalent to calling GetPrim(primPath)
, and then calling HdContainerDataSource::Get
(prim.dataSource, locator).
Definition at line 99 of file sceneIndex.h.
HD_API std::string GetDisplayName | ( | ) | const |
Returns a value previously set by SetDisplayName.
If no value (or an empty string) was last set, this returns a symbol-demangled version of the class type itself. This is in service of user interfaces with views of scene index chains or graphs.
|
pure virtual |
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.
Implemented in HdFlatteningSceneIndex, HdLegacyGeomSubsetSceneIndex, HdMergingSceneIndex, HdPrefixingSceneIndex, HdRetainedSceneIndex, HdGpGenerativeProceduralFilteringSceneIndex, HdGpGenerativeProceduralResolvingSceneIndex, HdsiCoordSysPrimSceneIndex, HdsiExtComputationDependencySceneIndex, HdsiImplicitSurfaceSceneIndex, HdsiLegacyDisplayStyleOverrideSceneIndex, HdsiLightLinkingSceneIndex, HdsiMaterialBindingResolvingSceneIndex, HdsiMaterialPrimvarTransferSceneIndex, HdsiNurbsApproximatingSceneIndex, HdsiPrimTypeAndPathPruningSceneIndex, HdsiPrimTypeNoticeBatchingSceneIndex, HdsiPrimTypePruningSceneIndex, HdsiRenderSettingsFilteringSceneIndex, HdsiSwitchingSceneIndex, HdsiTetMeshConversionSceneIndex, UsdImagingDrawModeSceneIndex, UsdImagingExtentResolvingSceneIndex, UsdImagingMaterialBindingsResolvingSceneIndex, UsdImagingNiPrototypePropagatingSceneIndex, UsdImagingPiPrototypePropagatingSceneIndex, UsdImagingRenderSettingsFlatteningSceneIndex, UsdImagingRerootingSceneIndex, UsdImagingRootOverridesSceneIndex, UsdImagingSelectionSceneIndex, UsdImagingUnloadedDrawModeSceneIndex, HdMaterialFilteringSceneIndexBase, HdSiExtComputationPrimvarPruningSceneIndex, HdsiPinnedCurveExpandingSceneIndex, and HdsiSceneGlobalsSceneIndex.
HD_API TfTokenVector GetTags | ( | ) | const |
Returns all tag tokens currently added to a scene index instance.
This is in service of user interfaces which want to filter views of a scene index chain or graph.
HD_API bool HasTag | ( | const TfToken & | tag | ) | const |
Returns true if a specified tag token has been added to a scene index instance.
This is in service of user interfaces which want to filter views of a scene index chain or graph.
HD_API void RemoveObserver | ( | const HdSceneIndexObserverPtr & | observer | ) |
Removes an observer from this scene index; the given observer will no longer be forwarded notices.
Note that the observer won't get any notices as a result of being detached from this scene index. If observer
is not registered on this scene index, this call does nothing. This function is not threadsafe.
HD_API void RemoveTag | ( | const TfToken & | tag | ) |
Removes a specified tag token to a scene index instance.
This is in service of user interfaces which want to filter views of a scene index chain or graph.
HD_API void SetDisplayName | ( | const std::string & | n | ) |
Allows for scene index instances to be identified in a more contextually relevant way.
This is in service of user interfaces with views of scene index chains or graphs.
HD_API void SystemMessage | ( | const TfToken & | messageType, |
const HdDataSourceBaseHandle & | args | ||
) |
Sends a message with optional arguments to this and any upstream input scene indices.
Scene indices may implement _SystemMessage to provide custom handling. See systemMessages.h for common message definitions.