HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HdGpGenerativeProceduralResolvingSceneIndex Class Reference

#include <generativeProceduralResolvingSceneIndex.h>

+ Inheritance diagram for HdGpGenerativeProceduralResolvingSceneIndex:

Public Member Functions

HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 SATISFYING HdSceneIndexBase ///////////////////////////////////////////. More...
 
SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 
- Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API std::vector
< HdSceneIndexBaseRefPtr > 
GetInputScenes () const final
 
- Public Member Functions inherited from HdSceneIndexBase
HD_API HdSceneIndexBase ()
 
HD_API ~HdSceneIndexBase () override
 
HD_API void AddObserver (const HdSceneIndexObserverPtr &observer)
 
HD_API void RemoveObserver (const HdSceneIndexObserverPtr &observer)
 
HdDataSourceBaseHandle GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const
 
HD_API void SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
 
HD_API std::string GetDisplayName () const
 
HD_API void SetDisplayName (const std::string &n)
 
HD_API void AddTag (const TfToken &tag)
 
HD_API void RemoveTag (const TfToken &tag)
 
HD_API bool HasTag (const TfToken &tag) const
 
HD_API TfTokenVector GetTags () const
 
- Public Member Functions inherited from TfRefBase
 TfRefBase ()
 
 TfRefBase (TfRefBase const &)
 
TfRefBaseoperator= (TfRefBase const &)
 
size_t GetCurrentCount () const
 Return the current reference count of this object. More...
 
bool IsUnique () const
 Return true if only one TfRefPtr points to this object. More...
 
void SetShouldInvokeUniqueChangedListener (bool shouldCall)
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase ()
 
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase__GetTfWeakBase__ () const
 
const TfWeakBaseoperator= (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 Public Member Functions inherited from TfRefBase
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 ///////////////////////. More...
 
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
 
- 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
 
- Protected Member Functions inherited from HdSceneIndexBase
HD_API void _SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)
 
HD_API void _SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)
 
HD_API void _SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
 
HD_API void _SendPrimsRenamed (const HdSceneIndexObserver::RenamedPrimEntries &entries)
 
HD_API bool _IsObserved () const
 
- Protected Member Functions inherited from TfRefBase
virtual TF_API ~TfRefBase ()
 
- Protected Member Functions inherited from TfWeakBase
 ~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)
 

Detailed Description

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 62 of file generativeProceduralResolvingSceneIndex.h.

Constructor & Destructor Documentation

HdGpGenerativeProceduralResolvingSceneIndex::HdGpGenerativeProceduralResolvingSceneIndex ( const HdSceneIndexBaseRefPtr &  inputScene)
protected
HdGpGenerativeProceduralResolvingSceneIndex::HdGpGenerativeProceduralResolvingSceneIndex ( const HdSceneIndexBaseRefPtr &  inputScene,
const TfToken targetPrimTypeName 
)
protected

Member Function Documentation

void HdGpGenerativeProceduralResolvingSceneIndex::_PrimsAdded ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::AddedPrimEntries entries 
)
overrideprotectedvirtual

SATISFYING HdSingleInputFilteringSceneIndexBase ///////////////////////.

Implements HdSingleInputFilteringSceneIndexBase.

void HdGpGenerativeProceduralResolvingSceneIndex::_PrimsDirtied ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::DirtiedPrimEntries entries 
)
overrideprotectedvirtual
void HdGpGenerativeProceduralResolvingSceneIndex::_PrimsRemoved ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::RemovedPrimEntries entries 
)
overrideprotectedvirtual
void HdGpGenerativeProceduralResolvingSceneIndex::_SystemMessage ( const TfToken messageType,
const HdDataSourceBaseHandle &  args 
)
overrideprotectedvirtual

Implement in order to react directly to system messages sent from downstream.

Reimplemented from HdSceneIndexBase.

SdfPathVector HdGpGenerativeProceduralResolvingSceneIndex::GetChildPrimPaths ( const SdfPath primPath) const
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.

HdSceneIndexPrim HdGpGenerativeProceduralResolvingSceneIndex::GetPrim ( const SdfPath primPath) const
overridevirtual

SATISFYING HdSceneIndexBase ///////////////////////////////////////////.

Implements HdSceneIndexBase.

static HdGpGenerativeProceduralResolvingSceneIndexRefPtr HdGpGenerativeProceduralResolvingSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputScene)
inlinestatic

Definition at line 67 of file generativeProceduralResolvingSceneIndex.h.

static HdGpGenerativeProceduralResolvingSceneIndexRefPtr HdGpGenerativeProceduralResolvingSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputScene,
const TfToken targetPrimTypeName 
)
inlinestatic

Definition at line 73 of file generativeProceduralResolvingSceneIndex.h.


The documentation for this class was generated from the following file: