udimUtils.h

//
// Copyright 2023 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache 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