omni/connect/core/Core.h

File members: omni/connect/core/Core.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 <omni/core/OmniInit.h>

#include <string>
#include <vector>

namespace omni::connect::core
{

OMNICONNECTCORE_API const char* version();

OMNICONNECTCORE_API bool withNucleus();

#if OMNICONNECTCORE_WITH_NUCLEUS
OMNICONNECTCORE_API const char* clientVersion();
#endif // OMNICONNECTCORE_WITH_NUCLEUS

#define OMNICONNECTCORE_INIT(...)                                                                                                                    \
    if (!carb::getFramework())                                                                                                                       \
    {                                                                                                                                                \
        carb::acquireFrameworkAndRegisterBuiltins();                                                                                                 \
    }                                                                                                                                                \
    omni::connect::core::startup();

OMNICONNECTCORE_API bool initialized();

OMNICONNECTCORE_API bool startup();

OMNICONNECTCORE_API const char* carbAppPath();

OMNICONNECTCORE_API bool loadCarbPlugin(const std::string& name, const std::vector<std::string>& extraSearchPaths = {});

#if OMNICONNECTCORE_WITH_NUCLEUS

OMNICONNECTCORE_API bool isOmniUri(const std::string& uri);

OMNICONNECTCORE_API bool isLocalUri(const std::string& uri);

OMNICONNECTCORE_API bool doesUriExist(const std::string& uri);

OMNICONNECTCORE_API bool isUriWritable(const std::string& uri);

OMNICONNECTCORE_API std::string getUser(const std::string& uri);

OMNICONNECTCORE_API bool createUriCheckpoint(const std::string& uri, const char* comment = nullptr);

OMNICONNECTCORE_API bool registerOmniUsdResolverPlugin();

#endif // OMNICONNECTCORE_WITH_NUCLEUS

} // namespace omni::connect::core