extCompCpuComputation.h

//
// Copyright 2017 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_IMAGING_HD_ST_EXT_COMP_CPU_COMPUTATION_H
#define PXR_IMAGING_HD_ST_EXT_COMP_CPU_COMPUTATION_H
 
#include "pxr/pxr.h"
#include "pxr/imaging/hdSt/api.h"
 
#include "pxr/imaging/hd/bufferSource.h"
 
#include "pxr/usd/sdf/path.h"
 
#include "pxr/base/tf/token.h"
#include "pxr/base/vt/value.h"
 
#include <memory>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
 
class HdSceneDelegate;
class HdExtComputation;
 
using HdStExtCompCpuComputationSharedPtr =
    std::shared_ptr<class HdStExtCompCpuComputation>;
using HdSt_ExtCompInputSourceSharedPtr =
    std::shared_ptr<class HdSt_ExtCompInputSource>;
using HdSt_ExtCompInputSourceSharedPtrVector =
    std::vector<HdSt_ExtCompInputSourceSharedPtr>;
 
class HdStExtCompCpuComputation final : public HdNullBufferSource
{
public:
    HDST_API
    static const size_t INVALID_OUTPUT_INDEX;
 
    HdStExtCompCpuComputation(
        const SdfPath &id,
        const HdSt_ExtCompInputSourceSharedPtrVector &inputs,
        const TfTokenVector &outputs,
        int numElements,
        HdSceneDelegate *sceneDelegate);
 
    HDST_API
    ~HdStExtCompCpuComputation() override;
 
    HDST_API
    static HdStExtCompCpuComputationSharedPtr
    CreateComputation(HdSceneDelegate *sceneDelegate,
                      const HdExtComputation &computation,
                      HdBufferSourceSharedPtrVector *computationSources);
 
    HDST_API
    TfToken const &GetName() const override;
 
    HDST_API
    bool Resolve() override;
 
    HDST_API
    size_t GetNumElements() const override;
 
 
    HDST_API
    size_t GetOutputIndex(const TfToken &outputName) const;
 
    HDST_API
    const VtValue &GetOutputByIndex(size_t index) const;
 
protected:
    HDST_API
    bool _CheckValid() const override;
 
private:
    SdfPath                                 _id;
    HdSt_ExtCompInputSourceSharedPtrVector  _inputs;
    TfTokenVector                           _outputs;
    size_t                                  _numElements;
    HdSceneDelegate                        *_sceneDelegate;
 
    std::vector<VtValue>                    _outputValues;
 
    HdStExtCompCpuComputation() = delete;
    HdStExtCompCpuComputation(
        const HdStExtCompCpuComputation &) = delete;
    HdStExtCompCpuComputation &operator = (
        const HdStExtCompCpuComputation &) = delete;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_IMAGING_HD_ST_EXT_COMP_CPU_COMPUTATION_H