omni/connect/core/StageAlgo.h

File members: omni/connect/core/StageAlgo.h

// SPDX-FileCopyrightText: Copyright (c) 2022-2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: LicenseRef-NvidiaProprietary
//
// NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
// property and proprietary rights in and to this material, related
// documentation and any modifications thereto. Any use, reproduction,
// disclosure or distribution of this material and related documentation
// without an express license agreement from NVIDIA CORPORATION or
// its affiliates is strictly prohibited.

#pragma once

#include "Api.h"

#include <pxr/base/tf/token.h>
#include <pxr/usd/sdf/layer.h>
#include <pxr/usd/usd/prim.h>
#include <pxr/usd/usd/stage.h>

namespace omni::connect::core
{

OMNICONNECTCORE_API pxr::UsdStageRefPtr createStage(
    const std::string& identifier,
    const std::string& defaultPrimName,
    const pxr::TfToken& upAxis,
    const double linearUnits,
    const pxr::SdfLayer::FileFormatArguments& fileFormatArgs = pxr::SdfLayer::FileFormatArguments()
);

OMNICONNECTCORE_API bool configureStage(
    pxr::UsdStagePtr stage,
    const std::string& defaultPrimName,
    const pxr::TfToken& upAxis,
    const double linearUnits
);

OMNICONNECTCORE_API void saveStage(pxr::UsdStagePtr stage, const char* comment = nullptr);

OMNICONNECTCORE_API bool canRemovePrim(const pxr::UsdPrim& prim);

OMNICONNECTCORE_API bool removeOrDeactivatePrim(pxr::UsdPrim prim);

OMNICONNECTCORE_API bool copyPrim(const pxr::UsdPrim& prim, const pxr::SdfPath& destination);

OMNICONNECTCORE_API bool renamePrim(pxr::UsdPrim prim, const pxr::TfToken& name);

} // namespace omni::connect::core