computedDataSource.h

Go to the documentation of this file.

//
// Copyright 2026 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_IMAGING_USD_EXEC_IMAGING_COMPUTED_DATA_SOURCE_H
#define PXR_USD_IMAGING_USD_EXEC_IMAGING_COMPUTED_DATA_SOURCE_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/usdImaging/usdExecImaging/api.h"
#include "pxr/usdImaging/usdExecImaging/requestAccessor.h"
#include "pxr/usdImaging/usdExecImaging/valueKey.h"
 
#include "pxr/base/vt/value.h"
#include "pxr/imaging/hd/dataSource.h"
 
#include <utility>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class UsdExecImaging_ComputedDataSourceImpl
{
public:
    using Time = HdSampledDataSource::Time;
 
    USDEXECIMAGING_API
    UsdExecImaging_ComputedDataSourceImpl(
        UsdExecImagingRequestAccessorSharedPtr requestAccessor,
        UsdExecImagingValueKey valueKey);
 
    USDEXECIMAGING_API
    VtValue GetValue(Time shutterOffset) const;
 
    USDEXECIMAGING_API
    bool GetContributingSampleTimesForInterval(
        Time startTime, 
        Time endTime,
        std::vector<Time> * outSampleTimes) const;
 
private:
    UsdExecImagingRequestAccessorSharedPtr _requestAccessor;
    UsdExecImagingValueKey _valueKey;
};
 
class UsdExecImagingComputedSampledDataSource : public HdSampledDataSource
{
public:
    HD_DECLARE_DATASOURCE(UsdExecImagingComputedSampledDataSource)
 
    USDEXECIMAGING_API
    ~UsdExecImagingComputedSampledDataSource() override;
 
    VtValue GetValue(Time shutterOffset) override {
        return _impl.GetValue(shutterOffset);
    }
 
    bool GetContributingSampleTimesForInterval(
        Time startTime, 
        Time endTime,
        std::vector<Time> *outSampleTimes) override {
        return _impl.GetContributingSampleTimesForInterval(
            startTime, endTime, outSampleTimes);
    }
 
private:
    UsdExecImagingComputedSampledDataSource(
        UsdExecImagingRequestAccessorSharedPtr requestAccessor,
        UsdExecImagingValueKey valueKey)
        : _impl(std::move(requestAccessor), std::move(valueKey))
    {}
 
private:
    UsdExecImaging_ComputedDataSourceImpl _impl;
};
 
template <class ValueType>
class UsdExecImagingComputedTypedSampledDataSource
    : public HdTypedSampledDataSource<ValueType>
{
public:
    HD_DECLARE_DATASOURCE(
        UsdExecImagingComputedTypedSampledDataSource<ValueType>);
 
    using Time = HdSampledDataSource::Time;
 
    VtValue GetValue(Time shutterOffset) override {
        return _impl.GetValue(shutterOffset);
    }
 
    ValueType GetTypedValue(Time shutterOffset) override {
        return _impl.GetValue(shutterOffset).template Get<ValueType>();
    }
 
    bool GetContributingSampleTimesForInterval(
        Time startTime, 
        Time endTime,
        std::vector<Time> *outSampleTimes) override {
        return _impl.GetContributingSampleTimesForInterval(
            startTime, endTime, outSampleTimes);
    }
 
private:
    UsdExecImagingComputedTypedSampledDataSource(
        UsdExecImagingRequestAccessorSharedPtr requestAccessor,
        UsdExecImagingValueKey valueKey)
        : _impl(std::move(requestAccessor), std::move(valueKey))
    {}
 
private:
    UsdExecImaging_ComputedDataSourceImpl _impl;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif