udimUtils.h

//
// Copyright 2023 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_USD_SHADE_UDIM_UTILS_H
#define PXR_USD_USD_SHADE_UDIM_UTILS_H
 
#include "pxr/pxr.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/usdShade/api.h"
 
#include <string>
#include <utility>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_DECLARE_HANDLES(SdfLayer);
 
class UsdShadeUdimUtils {
public:
 
    using ResolvedPathAndTile = std::pair<std::string, std::string>;
 
    USDSHADE_API
    static bool IsUdimIdentifier(const std::string &identifier);
    
    USDSHADE_API
    static std::string ReplaceUdimPattern(
        const std::string &identifierWithPattern,
        const std::string &replacement);
 
    USDSHADE_API
    static std::string ResolveUdimPath(
        const std::string &udimPath,
        const SdfLayerHandle &layer);
 
    USDSHADE_API
    static std::vector<ResolvedPathAndTile> ResolveUdimTilePaths(
        const std::string &udimPath,
        const SdfLayerHandle &layer);
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif