HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
HdGpGenerativeProceduralFilteringSceneIndex Class Referencefinal

#include <generativeProceduralFilteringSceneIndex.h>

+ Inheritance diagram for HdGpGenerativeProceduralFilteringSceneIndex:

Public Member Functions

HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 
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 &)
 
TfRefBase & operator= (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 TfWeakBase & operator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Static Public Member Functions

static
HdGpGenerativeProceduralFilteringSceneIndexRefPtr 		New (const HdSceneIndexBaseRefPtr &inputScene, const TfTokenVector &allowedProceduralTypes)
 
static
HdGpGenerativeProceduralFilteringSceneIndexRefPtr 		New (const HdSceneIndexBaseRefPtr &inputScene, const TfTokenVector &allowedProceduralTypes, const std::optional< TfToken > &targetPrimTypeName, const std::optional< TfToken > &allowedPrimTypeName, const std::optional< TfToken > &skippedPrimTypeName)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Additional Inherited Members

- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr )(TfRefBase const *, bool)
 
- 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
 
virtual HD_API void _SystemMessage (const TfToken &messageType, const HdDataSourceBaseHandle &args)
 
- 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
 

Detailed Description

HdGpGenerativeProceduralFilteringSceneIndex is a scene index which filters prims representing generative procedurals within its incoming scene against a requested pattern.

Typically, this scene index re-types (to its observers) any procedural prim it filters to the type "skippedGenerativeProcedural" and ones that are allowed will have their types remain the same. This scene index can also be configured to have specific primTypes for procedurals that are skipped or allowed.

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".

Definition at line 38 of file generativeProceduralFilteringSceneIndex.h.

Member Function Documentation

SdfPathVector HdGpGenerativeProceduralFilteringSceneIndex::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 HdGpGenerativeProceduralFilteringSceneIndex::GetPrim ( const SdfPath &  primPath) const
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.

static HdGpGenerativeProceduralFilteringSceneIndexRefPtr HdGpGenerativeProceduralFilteringSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputScene,
const TfTokenVector &  allowedProceduralTypes 
)
inlinestatic

Definition at line 42 of file generativeProceduralFilteringSceneIndex.h.

static HdGpGenerativeProceduralFilteringSceneIndexRefPtr HdGpGenerativeProceduralFilteringSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputScene,
const TfTokenVector &  allowedProceduralTypes,
const std::optional< TfToken > &  targetPrimTypeName,
const std::optional< TfToken > &  allowedPrimTypeName,
const std::optional< TfToken > &  skippedPrimTypeName 
)
inlinestatic

This constructs a filtering scene index that will try to filter prims of type targetPrimType. For each prim of this type, allowedProceduralTypes will be used to determined if the procedural is "allowed" or "skipped".

Prims that are not of type targetPrimType are left alone.

If allowedPrimTypeName is specified, then "allowed" prims will have their type set to that. Otherwise, it will be set to targetPrimType.

If skippedPrimTypeName is specified, then "skipped" prims will have their type set to that. Otherwise, it will be set to "skippedGenerativeProcedural".

Definition at line 63 of file generativeProceduralFilteringSceneIndex.h.

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