Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HdsiPinnedCurveExpandingSceneIndex Class Reference

Pinned curves are a special case of non-periodic cubic curves (relevant only for BSpline and CatmullRom basis) where the authored intent is for each curve to begin and end at its first and last control points respectively. More...

+ Inheritance diagram for HdsiPinnedCurveExpandingSceneIndex:

Public Member Functions

HDSI_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const override final
 Returns a pair of (prim type, datasource) for the object at primPath. More...
 
HDSI_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const override final
 Returns the paths of all scene index prims located immediately below primPath. More...
 
- Public Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API std::vector< HdSceneIndexBaseRefPtr > GetInputScenes () const final
 
- Public Member Functions inherited from HdSceneIndexBase
HD_API void AddObserver (const HdSceneIndexObserverPtr &observer)
 Adds an observer to this scene index. More...
 
HD_API void RemoveObserver (const HdSceneIndexObserverPtr &observer)
 Removes an observer from this scene index; the given observer will no longer be forwarded notices. More...
 
HdDataSourceBaseHandle GetDataSource (const SdfPath &primPath, const HdDataSourceLocator &locator) const
 A convenience function: look up the object at primPath, and if successful return the datasource at locator within that prim. More...
 
- Public Member Functions inherited from 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 TfRefCount & GetRefCount () const
 
void SetShouldInvokeUniqueChangedListener (bool shouldCall)
 
- Public Member Functions inherited from 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 HDSI_API HdsiPinnedCurveExpandingSceneIndexRefPtr New (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
- Static Public Member Functions inherited from TfRefBase
static TF_API void SetUniqueChangedListener (UniqueChangedListener listener)
 

Protected Member Functions

HDSI_API void _PrimsAdded (const HdSceneIndexBase &sender, const HdSceneIndexObserver::AddedPrimEntries &entries) override final
 
HDSI_API void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) override final
 
HDSI_API void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) override final
 
HDSI_API HdsiPinnedCurveExpandingSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
- Protected Member Functions inherited from HdSingleInputFilteringSceneIndexBase
HD_API HdSingleInputFilteringSceneIndexBase (const HdSceneIndexBaseRefPtr &inputSceneIndex)
 
const HdSceneIndexBaseRefPtr & _GetInputSceneIndex () const
 Returns the input scene. More...
 
- Protected Member Functions inherited from HdSceneIndexBase
HD_API void _SendPrimsAdded (const HdSceneIndexObserver::AddedPrimEntries &entries)
 Notify attached observers of prims added to the scene. More...
 
HD_API void _SendPrimsRemoved (const HdSceneIndexObserver::RemovedPrimEntries &entries)
 Notify attached observers of prims removed from the scene. More...
 
HD_API void _SendPrimsDirtied (const HdSceneIndexObserver::DirtiedPrimEntries &entries)
 Notify attached observers of datasource invalidations from the scene. More...
 
HD_API bool _IsObserved () const
 Returns whether the scene index has any registered observers; this information can be used to skip work preparing notices when there are no observers. More...
 
- Protected Member Functions inherited from 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

Pinned curves are a special case of non-periodic cubic curves (relevant only for BSpline and CatmullRom basis) where the authored intent is for each curve to begin and end at its first and last control points respectively.

This is done by setting the 'wrap' mode on the topology to 'pinned'.

Renderers that don't provide built-in support for pinned curves can use this scene index to "expand" or "unpack" the authored data. This involves the following:

  • Adding "phantom" points at the ends of each curve. For BSpline basis, each end point is repeated twice (so we have 3 consecutive identical points on each end) while for CatmullRom basis, each end point is repeated once. The topology is modified to reflect this.
  • Expanding vertex primvars to account for the additional control points and varying primvars to account for the additional segments.
Note
This scene index does not convert indexed curves (i.e., with authored curve indices) into non-indexed curves.

Definition at line 55 of file pinnedCurveExpandingSceneIndex.h.

Member Function Documentation

◆ GetChildPrimPaths()

HDSI_API SdfPathVector GetChildPrimPaths ( const SdfPath &  primPath) const
finaloverridevirtual

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.

◆ GetPrim()

HDSI_API HdSceneIndexPrim GetPrim ( const SdfPath &  primPath) const
finaloverridevirtual

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.

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