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

#include <pinnedCurveExpandingSceneIndex.h>

+ Inheritance diagram for HdsiPinnedCurveExpandingSceneIndex:

Public Member Functions

HDSI_API HdSceneIndexPrim GetPrim (const SdfPath &primPath) const overridefinal
HDSI_API SdfPathVector GetChildPrimPaths (const SdfPath &primPath) const overridefinal
- 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 &)
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 HDSI_API
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) overridefinal
HDSI_API void _PrimsRemoved (const HdSceneIndexBase &sender, const HdSceneIndexObserver::RemovedPrimEntries &entries) overridefinal
HDSI_API void _PrimsDirtied (const HdSceneIndexBase &sender, const HdSceneIndexObserver::DirtiedPrimEntries &entries) overridefinal
HDSI_API HdsiPinnedCurveExpandingSceneIndex (const HdSceneIndexBaseRefPtr &inputSceneIndex)
- 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

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

Constructor & Destructor Documentation

HDSI_API HdsiPinnedCurveExpandingSceneIndex::HdsiPinnedCurveExpandingSceneIndex ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)

Member Function Documentation

HDSI_API void HdsiPinnedCurveExpandingSceneIndex::_PrimsAdded ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::AddedPrimEntries entries 
HDSI_API void HdsiPinnedCurveExpandingSceneIndex::_PrimsDirtied ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::DirtiedPrimEntries entries 
HDSI_API void HdsiPinnedCurveExpandingSceneIndex::_PrimsRemoved ( const HdSceneIndexBase sender,
const HdSceneIndexObserver::RemovedPrimEntries entries 
HDSI_API SdfPathVector HdsiPinnedCurveExpandingSceneIndex::GetChildPrimPaths ( const SdfPath primPath) const

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 HdsiPinnedCurveExpandingSceneIndex::GetPrim ( const SdfPath primPath) const

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 HdsiPinnedCurveExpandingSceneIndexRefPtr HdsiPinnedCurveExpandingSceneIndex::New ( const HdSceneIndexBaseRefPtr &  inputSceneIndex)

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