input.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_INPUT_H
#define PXR_EXEC_VDF_INPUT_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
#include "pxr/exec/vdf/inputSpec.h"
#include "pxr/exec/vdf/mask.h"
#include "pxr/exec/vdf/types.h"
 
#include "pxr/base/tf/span.h"
 
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class VdfConnection;
class VdfNode;
class VdfOutput;
 
class VdfInput 
{
public:
 
    VDF_API
    ~VdfInput();
 
    VdfInput(VdfNode &owner, int specIndex, const VdfOutput *output = NULL) : 
        _owner(owner), _associatedOutput(output), _specIndex(specIndex) {
    }
 
    const VdfConnectionVector &GetConnections() const { return _connections; }
 
    size_t GetNumConnections() const { 
        return _connections.size(); 
    }
 
    const VdfConnection &operator[](size_t index) const {
        return *_connections[index];
    }
 
    VdfConnection &GetNonConstConnection(size_t index) const {
        return *_connections[index];
    }
 
    VDF_API
    const VdfInputSpec &GetSpec() const;
 
    const VdfOutput *GetAssociatedOutput() const { return _associatedOutput; }
 
    const VdfNode &GetNode() const { return _owner; }
 
    VdfNode &GetNode() { return _owner; }
 
    const TfToken &GetName() const {
        return GetSpec().GetName();
    }
 
    VDF_API
    std::string GetDebugName() const;
 
private:
 
    // Only the VdfNetwork and VdfIsolatedSubnetwork should have access to the
    // connect API.
    friend class VdfNetwork;
    friend class VdfIsolatedSubnetwork;
    
    // VdfOutput needs to be able to call _AddConnection().
    friend class VdfOutput;
 
    int _GetSpecIndex() const {
        return _specIndex;
    }
 
    VdfConnection *_AddConnection(
        VdfOutput &output,
        const VdfMask &mask,
        int atIndex);
 
    void _RemoveConnection(VdfConnection *connection);
 
    void _ReorderInputConnections(
        const TfSpan<const VdfConnectionVector::size_type> &newToOldIndices);
 
private:
 
    // The owner of this input connector.
    VdfNode &_owner;
 
    // A pointer to a corresponding output.  This is only non-null for in/out
    // connectors.
    const VdfOutput *_associatedOutput;
 
    // The list of connections on this connector.
    VdfConnectionVector _connections;
 
    // The index of the connector spec for this input on the owning node.
    int _specIndex;
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif