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

#include <stageSceneIndex.h>

+ Inheritance diagram for UsdImagingStageSceneIndex:

Public Member Functions

USDIMAGING_API ~UsdImagingStageSceneIndex ()
 
USDIMAGING_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 
USDIMAGING_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override
 
USDIMAGING_API void SetStage (UsdStageRefPtr stage)
 
USDIMAGING_API void SetTime (UsdTimeCode time, bool forceDirtyingTimeDeps=false)
 
USDIMAGING_API UsdTimeCode GetTime () const
 
USDIMAGING_API void ApplyPendingUpdates ()
 
- 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
UsdImagingStageSceneIndexRefPtr 
New (HdContainerDataSourceHandle const &inputArgs=nullptr)
 
- 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 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

Definition at line 55 of file stageSceneIndex.h.

Constructor & Destructor Documentation

USDIMAGING_API UsdImagingStageSceneIndex::~UsdImagingStageSceneIndex ( )

Member Function Documentation

USDIMAGING_API void UsdImagingStageSceneIndex::ApplyPendingUpdates ( )
USDIMAGING_API SdfPathVector UsdImagingStageSceneIndex::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.

USDIMAGING_API HdSceneIndexPrim UsdImagingStageSceneIndex::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.

USDIMAGING_API UsdTimeCode UsdImagingStageSceneIndex::GetTime ( ) const
static UsdImagingStageSceneIndexRefPtr UsdImagingStageSceneIndex::New ( HdContainerDataSourceHandle const &  inputArgs = nullptr)
inlinestatic

Definition at line 58 of file stageSceneIndex.h.

USDIMAGING_API void UsdImagingStageSceneIndex::SetStage ( UsdStageRefPtr  stage)
USDIMAGING_API void UsdImagingStageSceneIndex::SetTime ( UsdTimeCode  time,
bool  forceDirtyingTimeDeps = false 
)

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