UsdImagingDataSourceAttribute< T > Class Template Reference

#include <dataSourceAttribute.h>

Inheritance diagram for UsdImagingDataSourceAttribute< T >:

Public Member Functions
	HD_DECLARE_DATASOURCE (UsdImagingDataSourceAttribute< T >)
VtValue	GetValue (HdSampledDataSource::Time shutterOffset) override
T	GetTypedValue (HdSampledDataSource::Time shutterOffset) override
bool	GetContributingSampleTimesForInterval (HdSampledDataSource::Time startTime, HdSampledDataSource::Time endTime, std::vector< HdSampledDataSource::Time > *outSampleTimes) override
Public Member Functions inherited from HdTypedSampledDataSource< T >
	HD_DECLARE_DATASOURCE_ABSTRACT (HdTypedSampledDataSource< T >)
Public Member Functions inherited from HdSampledDataSource
	HD_DECLARE_DATASOURCE_ABSTRACT (HdSampledDataSource)
Public Member Functions inherited from HdDataSourceBase
virtual HD_API	~HdDataSourceBase ()=0

Protected Member Functions
	UsdImagingDataSourceAttribute (const UsdAttribute &usdAttr, const UsdImagingDataSourceStageGlobals &stageGlobals, const SdfPath &sceneIndexPath=SdfPath::EmptyPath(), const HdDataSourceLocator &timeVaryingFlagLocator=HdDataSourceLocator::EmptyLocator())
	UsdImagingDataSourceAttribute (const UsdAttributeQuery &usdAttrQuery, const UsdImagingDataSourceStageGlobals &stageGlobals, const SdfPath &sceneIndexPath=SdfPath::EmptyPath(), const HdDataSourceLocator &timeVaryingFlagLocator=HdDataSourceLocator::EmptyLocator())
	Constructor override taking an attribute query. More...

Protected Attributes
UsdAttributeQuery	_usdAttrQuery
const UsdImagingDataSourceStageGlobals &	_stageGlobals

Additional Inherited Members
Public Types inherited from HdTypedSampledDataSource< T >
using	Type = T
Public Types inherited from HdSampledDataSource
using	Time = float

Detailed Description

template<typename T>
class UsdImagingDataSourceAttribute< T >

Definition at line 26 of file dataSourceAttribute.h.

Constructor & Destructor Documentation

template<typename T >

UsdImagingDataSourceAttribute< T >::UsdImagingDataSourceAttribute ( const UsdAttribute &  usdAttr, const UsdImagingDataSourceStageGlobals &  stageGlobals, const SdfPath &  sceneIndexPath = SdfPath::EmptyPath(), const HdDataSourceLocator &  timeVaryingFlagLocator = HdDataSourceLocator::EmptyLocator()  )

protected

Constructors and member data are protected instead of private for use by a specialized subclass for accessing SdfAssetPath attributes which need special handling for UDIMs. Constructs a new UsdImagingDataSourceAttribute for the given usdAttr

stageGlobals represents the context object for the UsdStage with which to evaluate this attribute data source.

timeVaryingFlagLocator represents the locator that should be dirtied when time changes, if this attribute is time varying. An empty locator means that this attribute isn't tracked for time varyingness. This is distinct from the attribute name, say, because the attribute name may not correspond to a meaningful Hydra dirty locator. It's the responsibility of whoever is instantiating this data source to know the meaning of this attribute to Hydra.

Note: client code is calling the constructor via static New.

template<typename T >

UsdImagingDataSourceAttribute< T >::UsdImagingDataSourceAttribute ( const UsdAttributeQuery &  usdAttrQuery, const UsdImagingDataSourceStageGlobals &  stageGlobals, const SdfPath &  sceneIndexPath = SdfPath::EmptyPath(), const HdDataSourceLocator &  timeVaryingFlagLocator = HdDataSourceLocator::EmptyLocator()  )

protected

Constructor override taking an attribute query.

Member Function Documentation

template<typename T >

bool UsdImagingDataSourceAttribute< T >::GetContributingSampleTimesForInterval ( HdSampledDataSource::Time  startTime, HdSampledDataSource::Time  endTime, std::vector< HdSampledDataSource::Time > *  outSampleTimes  )

inlineoverridevirtual

Fills the outSampleTimes with the times between startTime and endTime that have valid sample data and returns true.

Implements HdSampledDataSource.

Definition at line 56 of file dataSourceAttribute.h.

template<typename T >

T UsdImagingDataSourceAttribute< T >::GetTypedValue ( HdSampledDataSource::Time  shutterOffset )

inlineoverridevirtual

Returns the extracted T value of the attribute at shutterOffset

Implements HdTypedSampledDataSource< T >.

Definition at line 41 of file dataSourceAttribute.h.

template<typename T >

VtValue UsdImagingDataSourceAttribute< T >::GetValue ( HdSampledDataSource::Time  shutterOffset )

inlineoverridevirtual

Returns the VtValue of this attribute at a given shutterOffset

Implements HdSampledDataSource.

Definition at line 34 of file dataSourceAttribute.h.

template<typename T >

UsdImagingDataSourceAttribute< T >::HD_DECLARE_DATASOURCE

(

UsdImagingDataSourceAttribute< T >

)

Member Data Documentation

template<typename T >

const UsdImagingDataSourceStageGlobals& UsdImagingDataSourceAttribute< T >::_stageGlobals

protected

Definition at line 144 of file dataSourceAttribute.h.

template<typename T >

UsdAttributeQuery UsdImagingDataSourceAttribute< T >::_usdAttrQuery

protected

Definition at line 143 of file dataSourceAttribute.h.

---

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

• pxr/usdImaging/usdImaging/dataSourceAttribute.h