HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
HdRetainedSampledDataSource Class Reference

#include <retainedDataSource.h>

+ Inheritance diagram for HdRetainedSampledDataSource:

Public Member Functions

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

Additional Inherited Members

- Public Types inherited from HdSampledDataSource
using Time = float
 

Detailed Description

A retained data source for sampled data. Typically used when the data needs to be locally stored and cut off from any backing scene data.

Definition at line 129 of file retainedDataSource.h.

Constructor & Destructor Documentation

HdRetainedSampledDataSource::HdRetainedSampledDataSource ( VtValue  value)
inline

Definition at line 134 of file retainedDataSource.h.

Member Function Documentation

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

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. For a sample-based attribute, this might be a list of times when samples are defined. For a procedural scene, this might be a generated distribution. Note that the returned samples don't need to be within startTime and endTime; if a boundary sample is outside of the window, implementers can return it, and callers should expect it and interpolate to startTime or endTime accordingly. If this call returns true, the caller is expected to pass the list of outSampleTimes to GetValue. If this call returns false, this value is uniform across the shutter window and the caller should call GetValue(0) to get that uniform value.

Implements HdSampledDataSource.

Definition at line 137 of file retainedDataSource.h.

VtValue HdRetainedSampledDataSource::GetValue ( HdSampledDataSource::Time  shutterOffset)
inlineoverridevirtual

Returns the value of this data source at frame-relative time shutterOffset. The caller does not track the frame; the scene index producing this datasource is responsible for that, if applicable. Note that, although this call returns a VtValue for each shutter offset, the type of the held value is expected to be the same across all shutter offsets. This call is expected to be threadsafe.

Implements HdSampledDataSource.

Definition at line 145 of file retainedDataSource.h.

HdRetainedSampledDataSource::HD_DECLARE_DATASOURCE ( HdRetainedSampledDataSource  )
The documentation for this class was generated from the following file: