inputValueBlock.h

Go to the documentation of this file.

//
// Copyright 2025 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_EXEC_EF_INPUT_VALUE_BLOCK_H
#define PXR_EXEC_EF_INPUT_VALUE_BLOCK_H


#include "pxr/pxr.h"

#include "pxr/exec/ef/api.h"

#include "pxr/exec/vdf/maskedOutput.h"
#include "pxr/exec/vdf/maskedOutputVector.h"
#include "pxr/exec/vdf/typedVector.h"

#include <vector>
#include <utility>

PXR_NAMESPACE_OPEN_SCOPE

class VdfExecutorInterface;

class EfInputValueBlock
{

private:

    // The type representing the vector of (output, value) pairs.
    typedef std::vector< std::pair<VdfMaskedOutput, VdfVector *> > _VectorType;

public:

    EfInputValueBlock() = default;

    EF_API
    EfInputValueBlock(const EfInputValueBlock &rhs);

    EfInputValueBlock(EfInputValueBlock &&rhs) = default;

    EF_API
    ~EfInputValueBlock();

    EF_API
    EfInputValueBlock &operator=(const EfInputValueBlock &rhs);

    EfInputValueBlock &operator=(EfInputValueBlock &&rhs) = default;

    template <typename T>
    void AddOutputValuePair(const VdfMaskedOutput &output, const T &value)
    {
        _values.push_back(std::make_pair( output, new VdfTypedVector<T>()));
        _values.back().second->Set(value);
    }

    void AddOutputVectorPair(const VdfMaskedOutput &output, 
                             const VdfVector &value)
    {
        _values.push_back(std::make_pair( output, new VdfVector(value) ) );
    }

    EF_API
    void Apply(VdfExecutorInterface *executor, 
               VdfMaskedOutputVector *invalidationRequest = NULL) const;

    EF_API
    void InvalidateAndApply(VdfExecutorInterface *executor,
                            const VdfMaskedOutputVector &invalidationRequest) const;

    typedef _VectorType::const_iterator const_iterator;

    const_iterator begin() const {
        return _values.begin();
    }

    const_iterator end() const {
        return _values.end();
    }

    size_t GetSize() const {
        return _values.size();
    }

private:

    // Push invalidation on to the executor.
    //
    void _Invalidate(VdfExecutorInterface *executor,
                     const VdfMaskedOutputVector &invalidationRequest) const;

    // Sets the output values on the executor.
    //
    void _SetValues(VdfExecutorInterface *executor) const;

    // Clears the input value block.
    //
    void _Clear();

    // Appends the contents of \p to this object.
    //
    void _Append(const EfInputValueBlock &rhs);

private:

    // The value pairs that make up this block.
    _VectorType _values;

};

typedef std::vector< EfInputValueBlock > EfInputValueBlockVector;

PXR_NAMESPACE_CLOSE_SCOPE

#endif