iterator.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_VDF_ITERATOR_H
#define PXR_EXEC_VDF_ITERATOR_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
#include "pxr/exec/vdf/context.h"
#include "pxr/exec/vdf/types.h"
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TfToken;
class VdfConnection;
class VdfExecutorInterface;
class VdfMask;
class VdfNode;
class VdfOutput;
class VdfVector;
 
class VdfIterator
{
protected:
 
    ~VdfIterator() = default;
 
    const VdfNode &_GetNode(const VdfContext &context) const {
        return context._GetNode();
    }
 
    const VdfExecutorInterface &_GetExecutor(const VdfContext &context) const {
        return context._GetExecutor();
    }
 
    VDF_API
    const VdfVector *_GetInputValue(
        const VdfContext &context,
        const VdfConnection &connection,
        const VdfMask &mask) const;
 
    VDF_API
    const VdfVector &_GetRequiredInputValue(
        const VdfContext &context,
        const VdfConnection &connection,
        const VdfMask &mask) const;
 
    VDF_API
    const VdfOutput *_GetRequiredOutputForWriting(
        const VdfContext &context,
        const TfToken &name) const;
 
    VDF_API
    VdfVector *_GetOutputValueForWriting(
        const VdfContext &context,
        const VdfOutput &output) const;
 
    VDF_API
    bool _GetOutputMasks(
        const VdfContext &context,
        const VdfOutput &output,
        const VdfMask **requestMask,
        const VdfMask **affectsMask) const;
 
    VDF_API
    bool _IsRequiredInput(
        const VdfContext &context,
        const VdfConnection &connection) const;
 
    VDF_API
    const VdfMask *_GetRequestMask(
        const VdfContext &context,
        const VdfOutput &output) const;
 
    VDF_API
    void _ForEachScheduledOutput(
        const VdfContext &context,
        const VdfNode &node,
        const VdfScheduledOutputCallback &callback) const;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif