UsdImagingDataSourceRelationship Class Reference

A data source that represents a USD relationship. More...

#include <dataSourceRelationship.h>

Inheritance diagram for UsdImagingDataSourceRelationship:

Public Member Functions
	HD_DECLARE_DATASOURCE (UsdImagingDataSourceRelationship)
USDIMAGING_API VtValue	GetValue (HdSampledDataSource::Time shutterOffset) override
	Returns the extracted path array value of the attribute, as a VtValue.
USDIMAGING_API VtArray< SdfPath >	GetTypedValue (HdSampledDataSource::Time shutterOffset) override
	Returns the extracted path array value of the attribute.
USDIMAGING_API bool	GetContributingSampleTimesForInterval (HdSampledDataSource::Time startTime, HdSampledDataSource::Time endTime, std::vector< HdSampledDataSource::Time > *outSampleTimes) override
	Returns false indicating USD relationhips cannot vary with time.
Public Member Functions inherited from HdTypedSampledDataSource< T >
	HD_DECLARE_DATASOURCE_ABSTRACT (HdTypedSampledDataSource< T >)
virtual T	GetTypedValue (Time shutterOffset)=0
	Returns the value of this data source at frame-relative time shutterOffset, as type T.
Public Member Functions inherited from HdSampledDataSource
	HD_DECLARE_DATASOURCE_ABSTRACT (HdSampledDataSource)
virtual VtValue	GetValue (Time shutterOffset)=0
	Returns the value of this data source at frame-relative time shutterOffset.
virtual bool	GetContributingSampleTimesForInterval (Time startTime, Time endTime, std::vector< Time > *outSampleTimes)=0
	Given a shutter window of interest (startTime and endTime relative to the current frame), return a list of sample times for the caller to query with GetValue such that the caller can reconstruct the signal over the shutter window.

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

Detailed Description

A data source that represents a USD relationship.

Definition at line 39 of file dataSourceRelationship.h.

Member Function Documentation

GetContributingSampleTimesForInterval()

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

overridevirtual

Returns false indicating USD relationhips cannot vary with time.

Implements HdSampledDataSource.

GetTypedValue()

USDIMAGING_API VtArray< SdfPath > GetTypedValue ( HdSampledDataSource::Time  shutterOffset )

overridevirtual

Returns the extracted path array value of the attribute.

shutterOffset is ignored.

Implements HdTypedSampledDataSource< T >.

GetValue()

USDIMAGING_API VtValue GetValue ( HdSampledDataSource::Time  shutterOffset )

overridevirtual

Returns the extracted path array value of the attribute, as a VtValue.

shutterOffset is ignored.

Implements HdSampledDataSource.

---

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

• pxr/usdImaging/usdImaging/dataSourceRelationship.h