RamsesFramework.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2015 BMW Car IT GmbH
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_RAMSESFRAMEWORK_H
#define RAMSES_RAMSESFRAMEWORK_H
 
#include "ramses-framework-api/RamsesFrameworkTypes.h"
#include "ramses-framework-api/RamsesFrameworkConfig.h"
#include "ramses-framework-api/StatusObject.h"
#include "ramses-framework-api/APIExport.h"
 
#include <memory>
#include <string>
#include <cstdint>
 
namespace ramses
{
    class DcsmProvider;
    class DcsmConsumer;
    class RamsesRenderer;
    class RamsesClient;
    class RendererConfig;
    class IRamshCommand;
 
    class RAMSES_API RamsesFramework : public StatusObject
    {
    public:
        RamsesFramework();
 
        RamsesFramework(int32_t argc, char const* const* argv);
 
        explicit RamsesFramework(const RamsesFrameworkConfig& config);
 
        status_t connect();
 
        bool isConnected() const;
 
        status_t disconnect();
 
        RamsesClient* createClient(const char* applicationName);
 
        status_t destroyClient(RamsesClient& client);
 
        RamsesRenderer* createRenderer(const RendererConfig& config);
 
        status_t destroyRenderer(RamsesRenderer& renderer);
 
        DcsmProvider* createDcsmProvider();
 
        status_t destroyDcsmProvider(const DcsmProvider& provider);
 
        DcsmConsumer* createDcsmConsumer();
 
        status_t destroyDcsmConsumer(const DcsmConsumer& consumer);
 
        static void SetConsoleLogLevel(ELogLevel logLevel);
 
        static void SetLogHandler(const LogHandlerFunc& logHandlerFunc);
 
        static uint64_t GetSynchronizedClockMilliseconds();
 
        status_t addRamshCommand(const std::shared_ptr<IRamshCommand>& command);
 
        status_t executeRamshCommand(const std::string& input);
 
        ~RamsesFramework() override;
 
        class RamsesFrameworkImpl& impl;
 
        RamsesFramework(const RamsesFramework& other) = delete;
 
        RamsesFramework& operator=(const RamsesFramework& other) = delete;
    };
}
 
#endif