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

#include <legacyPrimSceneIndex.h>

+ Inheritance diagram for HdLegacyPrimSceneIndex:

Public Member Functions

void AddLegacyPrim (SdfPath const &id, TfToken const &type, HdSceneDelegate *sceneDelegate)
 
void RemovePrim (SdfPath const &id)
 
void DirtyPrims (const HdSceneIndexObserver::DirtiedPrimEntries &entries) override
 extends to also call DirtyPrim on HdDataSourceLegacyPrim More...
 
- Public Member Functions inherited from HdRetainedSceneIndex
virtual HD_API void AddPrims (const AddedPrimEntries &entries)
 
virtual HD_API void RemovePrims (const HdSceneIndexObserver::RemovedPrimEntries &entries)
 
HD_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 
HD_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 
- 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 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 ()
 
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...
 
const TfRefCountGetRefCount () const
 
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 constGetUniqueIdentifier () const
 

Static Public Member Functions

static HdLegacyPrimSceneIndexRefPtr New ()
 
- Static Public Member Functions inherited from HdRetainedSceneIndex
static HD_API
HdRetainedSceneIndexRefPtr 
New ()
 Creates a new retained scene index. More...
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Additional Inherited Members

- Public Types inherited from HdRetainedSceneIndex
using AddedPrimEntries = std::vector< AddedPrimEntry >
 
- Public Types inherited from TfRefBase
typedef void(* UniqueChangedFuncPtr )(TfRefBase const *, bool)
 
- Protected Member Functions inherited from HdRetainedSceneIndex
HD_API HdRetainedSceneIndex ()
 
- 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
 

Detailed Description

Extends HdRetainedSceneIndex to instantiate and dirty HdDataSourceLegacyPrim data sources.

During emulation of legacy HdSceneDelegates, HdRenderIndex forwards prim insertion calls here to produce a comparable HdSceneIndex representation

Definition at line 43 of file legacyPrimSceneIndex.h.

Member Function Documentation

void HdLegacyPrimSceneIndex::AddLegacyPrim ( SdfPath const id,
TfToken const type,
HdSceneDelegate sceneDelegate 
)

custom insertion wrapper called by HdRenderIndex during population of legacy HdSceneDelegates

void HdLegacyPrimSceneIndex::DirtyPrims ( const HdSceneIndexObserver::DirtiedPrimEntries entries)
overridevirtual

extends to also call DirtyPrim on HdDataSourceLegacyPrim

Reimplemented from HdRetainedSceneIndex.

static HdLegacyPrimSceneIndexRefPtr HdLegacyPrimSceneIndex::New ( )
inlinestatic

Definition at line 47 of file legacyPrimSceneIndex.h.

void HdLegacyPrimSceneIndex::RemovePrim ( SdfPath const id)

Remove only the prim at id without affecting children.

If id has children, it is replaced by an entry with no type and no data source. If id does not have children, it is removed from the retained scene index.

This is called by HdRenderIndex on behalf of legacy HdSceneDelegates to emulate the original behavior of Remove{B,R,S}Prim, which did not remove children.


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