|
A scene index that observes an input scene index and produces a comparable scene in which inherited state is represented at leaf prims. More...
#include <flatteningSceneIndex.h>
Public Member Functions | |
HD_API HdSceneIndexPrim | GetPrim (const SdfPath &primPath) const override |
Returns a pair of (prim type, datasource) for the object at primPath . | |
HD_API SdfPathVector | GetChildPrimPaths (const SdfPath &primPath) const override |
Returns the paths of all scene index prims located immediately below primPath . | |
const TfTokenVector & | GetFlattenedDataSourceNames () const |
Data sources under locator name in a prim source get flattened. | |
const HdFlattenedDataSourceProviderSharedPtrVector & | GetFlattenedDataSourceProviders () const |
Providers in the same order as GetFlattenedDataSourceNames. | |
Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase | |
HD_API std::vector< HdSceneIndexBaseRefPtr > | GetInputScenes () const final |
virtual std::vector< HdSceneIndexBaseRefPtr > | GetInputScenes () const =0 |
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) 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 |
Static Public Member Functions | |
static HdFlatteningSceneIndexRefPtr | New (HdSceneIndexBaseRefPtr const &inputScene, HdContainerDataSourceHandle const &inputArgs) |
Creates a new flattening scene index. | |
Static Public Member Functions inherited from TfRefBase | |
static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
Protected Member Functions | |
HD_API | HdFlatteningSceneIndex (HdSceneIndexBaseRefPtr const &inputScene, HdContainerDataSourceHandle const &inputArgs) |
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 void | _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries)=0 |
virtual void | _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries)=0 |
virtual void | _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries)=0 |
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 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) |
A scene index that observes an input scene index and produces a comparable scene in which inherited state is represented at leaf prims.
This kind of representation is useful for render delegates that require some/all the information to be available at the leaf prims. It is also useful to express scene description composition functionality (e.g., material binding resolution that factors inherited opinions) via flattened data source provider(s).
Definition at line 45 of file flatteningSceneIndex.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()
; 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.
|
inline |
Data sources under locator name in a prim source get flattened.
Definition at line 72 of file flatteningSceneIndex.h.
|
inline |
Providers in the same order as GetFlattenedDataSourceNames.
Definition at line 78 of file flatteningSceneIndex.h.
|
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.
|
inlinestatic |
Creates a new flattening scene index.
inputArgs maps names to HdFlattenedDataSourceProviderSharedPtr's. That provider flattens the data sources under the locator name in each prim source.
Definition at line 53 of file flatteningSceneIndex.h.