RamsesClient.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2014 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_RAMSESCLIENT_H
#define RAMSES_RAMSESCLIENT_H
 
#include "ramses-client-api/RamsesObject.h"
#include "ramses-client-api/SceneConfig.h"
#include "ramses-framework-api/RamsesFramework.h"
 
namespace ramses
{
    class Scene;
    class IClientEventHandler;
 
    class RAMSES_API RamsesClient : public RamsesObject
    {
    public:
        Scene* createScene(sceneId_t sceneId, const SceneConfig& sceneConfig = SceneConfig(), const char* name = nullptr);
 
        Scene* loadSceneFromFile(const char* fileName, bool localOnly = false);
 
        Scene* loadSceneFromMemory(std::unique_ptr<unsigned char[], void(*)(const unsigned char*)> data, size_t size, bool localOnly = false);
 
        Scene* loadSceneFromFileDescriptor(int fd, size_t offset, size_t length, bool localOnly = false);
 
        Scene* loadSceneFromFileDescriptor(sceneId_t sceneId, int fd, size_t offset, size_t length, bool localOnly = false);
 
        status_t loadSceneFromFileAsync(const char* fileName, bool localOnly = false);
 
        status_t destroy(Scene& scene);
 
        const Scene* findSceneByName(const char* name) const;
 
        Scene* findSceneByName(const char* name);
 
        const Scene* getScene(sceneId_t sceneId) const;
 
        Scene* getScene(sceneId_t sceneId);
 
        status_t dispatchEvents(IClientEventHandler& clientEventHandler);
 
        class RamsesClientImpl& impl;
 
        explicit RamsesClient(RamsesClientImpl&);
 
        RamsesClient() = delete;
 
        RamsesClient(const RamsesClient& other) = delete;
 
        RamsesClient& operator=(const RamsesClient& other) = delete;
 
    private:
        friend class ClientFactory;
 
        virtual ~RamsesClient();
    };
}
 
#endif