![]() |
|
HdGpGenerativeProceduralResolvingSceneIndex is a scene index which evaluates prims representing generative procedurals within its incoming scene and outputs their resulting prims its own observers. More...
#include <generativeProceduralResolvingSceneIndex.h>
Public Member Functions | |
HdSceneIndexPrim | GetPrim (const SdfPath &primPath) const override |
SATISFYING HdSceneIndexBase ///////////////////////////////////////////. | |
SdfPathVector | GetChildPrimPaths (const SdfPath &primPath) const override |
Returns the paths of all scene index prims located immediately below primPath . | |
![]() | |
HD_API std::vector< HdSceneIndexBaseRefPtr > | GetInputScenes () const final |
virtual std::vector< HdSceneIndexBaseRefPtr > | GetInputScenes () const =0 |
![]() | |
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. | |
![]() | |
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) |
![]() | |
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 HdGpGenerativeProceduralResolvingSceneIndexRefPtr | New (const HdSceneIndexBaseRefPtr &inputScene) |
static HdGpGenerativeProceduralResolvingSceneIndexRefPtr | New (const HdSceneIndexBaseRefPtr &inputScene, const TfToken &targetPrimTypeName) |
![]() | |
static TF_API void | SetUniqueChangedListener (UniqueChangedListener listener) |
Protected Member Functions | |
HdGpGenerativeProceduralResolvingSceneIndex (const HdSceneIndexBaseRefPtr &inputScene) | |
HdGpGenerativeProceduralResolvingSceneIndex (const HdSceneIndexBaseRefPtr &inputScene, const TfToken &targetPrimTypeName) | |
void | _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override |
SATISFYING HdSingleInputFilteringSceneIndexBase ///////////////////////. | |
void | _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override |
void | _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override |
void | _SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args) override |
Implement in order to react directly to system messages sent from downstream. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
TfRefPtr< Tf_Remnant > | _Register () const |
template<class T > | |
TfRefPtr< Tf_Remnant > | _Register (T *tempRmnt) const |
bool | _HasRemnant () const |
Additional Inherited Members | |
![]() | |
typedef void(* | UniqueChangedFuncPtr) (TfRefBase const *, bool) |
HdGpGenerativeProceduralResolvingSceneIndex is a scene index which evaluates prims representing generative procedurals within its incoming scene and outputs their resulting prims its own observers.
The hydra prim type used to identify generative procedurals can be configured per instance of this scene index to allow for a pipeline to stage when certain procedural prims are resolved within the chain of scene indicies. By default that type is "generativeProcedural".
This scene index also re-types (to its observers) any procedural prim it acts upon to be of type "resolvedGenerativeProcedural" to avoid potentially evaluating a single procedural multiple times.
In its current form, it does NOT recursively resolve any procedural prims which are the result of the procedural prims for which it is itself evaluting. Additionally, all procedural prims evaluated here see the same input scene – and not the results of other procedurals resolved by the same scene index instance.
Definition at line 45 of file generativeProceduralResolvingSceneIndex.h.
|
overrideprotectedvirtual |
SATISFYING HdSingleInputFilteringSceneIndexBase ///////////////////////.
Implements HdSingleInputFilteringSceneIndexBase.
|
overrideprotectedvirtual |
Implements HdSingleInputFilteringSceneIndexBase.
|
overrideprotectedvirtual |
Implements HdSingleInputFilteringSceneIndexBase.
|
overrideprotectedvirtual |
Implement in order to react directly to system messages sent from downstream.
Reimplemented from HdSceneIndexBase.
|
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.
|
overridevirtual |
SATISFYING HdSceneIndexBase ///////////////////////////////////////////.
Implements HdSceneIndexBase.
|
inlinestatic |
Definition at line 50 of file generativeProceduralResolvingSceneIndex.h.
|
inlinestatic |
Definition at line 56 of file generativeProceduralResolvingSceneIndex.h.