ramses-utils.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_RAMSES_UTILS_H
#define RAMSES_RAMSES_UTILS_H
 
#include "ramses-client-api/TextureEnums.h"
#include "ramses-client-api/TextureSwizzle.h"
#include "ramses-client-api/RamsesClient.h"
#include "ramses-framework-api/RamsesFrameworkTypes.h"
#include "ramses-framework-api/APIExport.h"
 
#include <vector>
#include <string>
 
namespace ramses
{
    class RamsesObject;
    class Effect;
    class Node;
    class Scene;
    class Texture2D;
    class UniformInput;
    class DataVector2f;
    class DataVector4f;
    struct MipLevelData;
    struct CubeMipLevelData;
 
    class RAMSES_API RamsesUtils
    {
    public:
        template <typename T>
        static const T* TryConvert(const RamsesObject& obj);
 
        template <typename T>
        static T* TryConvert(RamsesObject& obj);
 
        static Texture2D*  CreateTextureResourceFromPng(const char* pngFilePath, Scene& scene, const TextureSwizzle& swizzle = {}, const char* name = nullptr);
 
        static Texture2D*  CreateTextureResourceFromPngBuffer(const std::vector<unsigned char>& pngData, Scene& scene, const TextureSwizzle& swizzle = {}, const char* name = nullptr);
 
        static MipLevelData* GenerateMipMapsTexture2D(uint32_t width, uint32_t height, uint8_t bytesPerPixel, uint8_t* data, uint32_t& mipMapCount);
 
        static bool SaveImageBufferToPng(const std::string& filePath, const std::vector<uint8_t>& imageData, uint32_t width, uint32_t height);
 
        static bool SaveImageBufferToPng(const std::string& filePath, std::vector<uint8_t>& imageData, uint32_t width, uint32_t height, bool flipImageBufferVertically);
 
        static CubeMipLevelData* GenerateMipMapsTextureCube(uint32_t faceWidth, uint32_t faceHeight, uint8_t bytesPerPixel, uint8_t* data, uint32_t& mipMapCount);
 
        static void DeleteGeneratedMipMaps(MipLevelData*& data, uint32_t mipMapCount);
 
        static void DeleteGeneratedMipMaps(CubeMipLevelData*& data, uint32_t mipMapCount);
 
        static nodeId_t GetNodeId(const Node& node);
 
        static bool SetPerspectiveCameraFrustumToDataObjects(float fov, float aspectRatio, float nearPlane, float farPlane, DataVector4f& frustumPlanesData, DataVector2f& nearFarPlanesData);
 
        static Scene* LoadSceneFromMemory(RamsesClient& client, std::unique_ptr<unsigned char[]> data, size_t size, bool localOnly);
    };
 
    inline Scene* RamsesUtils::LoadSceneFromMemory(RamsesClient& client, std::unique_ptr<unsigned char[]> data, size_t size, bool localOnly)
    {
        std::unique_ptr<unsigned char[], void(*)(const unsigned char*)> dataWithDeleter(data.release(), [](const unsigned char* ptr) { delete[] ptr; });
        return client.loadSceneFromMemory(std::move(dataWithDeleter), size, localOnly);
    }
}
 
#endif