omni/connect/core/PrimAlgo.h

File members: omni/connect/core/PrimAlgo.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/usd/prim.h>

#include <string>
#include <vector>

namespace omni::connect::core
{

OMNICONNECTCORE_API std::string getDisplayName(const pxr::UsdPrim& prim);

OMNICONNECTCORE_API bool setDisplayName(pxr::UsdPrim prim, const std::string& name);

OMNICONNECTCORE_API bool clearDisplayName(pxr::UsdPrim prim);

OMNICONNECTCORE_API bool blockDisplayName(pxr::UsdPrim prim);

OMNICONNECTCORE_API std::string computeEffectiveDisplayName(const pxr::UsdPrim& prim);

OMNICONNECTCORE_API std::string getValidPrimName(const std::string& name);

OMNICONNECTCORE_API pxr::TfTokenVector getValidPrimNames(const std::vector<std::string>& names, const pxr::TfTokenVector& reservedNames = {});

OMNICONNECTCORE_API pxr::TfTokenVector getValidChildNames(const pxr::UsdPrim& prim, const std::vector<std::string>& names);

OMNICONNECTCORE_API std::string getValidPropertyName(const std::string& name);

OMNICONNECTCORE_API pxr::TfTokenVector getValidPropertyNames(const std::vector<std::string>& names, const pxr::TfTokenVector& reservedNames = {});

} // namespace omni::connect::core