grapher.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_GRAPHER_H
#define PXR_EXEC_VDF_GRAPHER_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/exec/vdf/api.h"
#include "pxr/exec/vdf/types.h"
 
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class VdfGrapherOptions;
class VdfNetwork;
class VdfNode;
 
class VdfGrapher 
{
public:
 
    
    VDF_API
    static void GraphToFile(const VdfNetwork &network,
                            const std::string &filename);
 
    VDF_API
    static void GraphToFile(const VdfNetwork &network,
                            const std::string &filename,
                            const VdfGrapherOptions &options);
 
    VDF_API
    static void GraphToTemporaryFile(const VdfNetwork &network,
                                     const VdfGrapherOptions &options);
 
    VDF_API
    static void GraphNodeNeighborhood(
        const VdfNode &node, 
        int maxInDepth, int maxOutDepth,
        const std::vector<std::string> &exclude = std::vector<std::string>());
 
    VDF_API
    static std::vector<const VdfNode *> GetNodesNamed(
        const VdfNetwork &network, 
        const std::string &name);
 
 
    VDF_API
    static std::string GetDotCommand(const std::string &dotFileName);
 
 
 
};
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif