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

#include <implicitSurfaceSceneIndex.h>

+ Inheritance diagram for HdsiImplicitSurfaceSceneIndex:

Public Member Functions

HDSI_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override
 
HDSI_API 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 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 HDSI_API
HdsiImplicitSurfaceSceneIndexRefPtr 
New (const HdSceneIndexBaseRefPtr &inputSceneIndex, const HdContainerDataSourceHandle &inputArgs)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

 HdsiImplicitSurfaceSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex, const HdContainerDataSourceHandle &inputArgs)
 
void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override
 
void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override
 
void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) 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

The implicit surface scene index can be "configured" to either generate the mesh for a given implicit primitive (for renderers that don't natively support it) or overload the transform to account for a different "spine" axis (relevant for cones, capsules and cylinders) for those that do.

Definition at line 49 of file implicitSurfaceSceneIndex.h.

Constructor & Destructor Documentation

HdsiImplicitSurfaceSceneIndex::HdsiImplicitSurfaceSceneIndex ( const HdSceneIndexBaseRefPtr &  inputSceneIndex,
const HdContainerDataSourceHandle &  inputArgs 
)
protected

Member Function Documentation

void HdsiImplicitSurfaceSceneIndex::_PrimsAdded ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::AddedPrimEntries entries 
)
overrideprotectedvirtual
void HdsiImplicitSurfaceSceneIndex::_PrimsDirtied ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::DirtiedPrimEntries entries 
)
overrideprotectedvirtual
void HdsiImplicitSurfaceSceneIndex::_PrimsRemoved ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::RemovedPrimEntries entries 
)
overrideprotectedvirtual
HDSI_API SdfPathVector HdsiImplicitSurfaceSceneIndex::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.

HDSI_API HdSceneIndexPrim HdsiImplicitSurfaceSceneIndex::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 HDSI_API HdsiImplicitSurfaceSceneIndexRefPtr HdsiImplicitSurfaceSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputSceneIndex,
const HdContainerDataSourceHandle &  inputArgs 
)
static

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