stitch.h

Go to the documentation of this file.

//
// Copyright 2016 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_UTILS_STITCH_H
#define PXR_USD_USD_UTILS_STITCH_H
 
 
#include "pxr/pxr.h"
#include "pxr/usd/usdUtils/api.h"
#include "pxr/usd/sdf/declareHandles.h"
#include "pxr/usd/sdf/spec.h"
 
#include <functional>
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_DECLARE_HANDLES(SdfLayer);
 
USDUTILS_API
void UsdUtilsStitchLayers(
    const SdfLayerHandle& strongLayer, 
    const SdfLayerHandle& weakLayer);
 
USDUTILS_API
void UsdUtilsStitchInfo(
    const SdfSpecHandle& strongObj, 
    const SdfSpecHandle& weakObj);
 
 
enum class UsdUtilsStitchValueStatus
{
    NoStitchedValue, 
    UseDefaultValue, 
    UseSuppliedValue 
};
 
using UsdUtilsStitchValueFn = std::function<
    UsdUtilsStitchValueStatus(
        const TfToken& field, const SdfPath& path,
        const SdfLayerHandle& strongLayer, bool fieldInStrongLayer,
        const SdfLayerHandle& weakLayer, bool fieldInWeakLayer,
        VtValue* stitchedValue)>;
 
USDUTILS_API
void UsdUtilsStitchLayers(
    const SdfLayerHandle& strongLayer, 
    const SdfLayerHandle& weakLayer,
    const UsdUtilsStitchValueFn& stitchValueFn);
 
USDUTILS_API
void UsdUtilsStitchInfo(
    const SdfSpecHandle& strongObj, 
    const SdfSpecHandle& weakObj,
    const UsdUtilsStitchValueFn& stitchValueFn);
 
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif /* PXR_USD_USD_UTILS_STITCH_H */