DcsmMetadataCreator.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2019 BMW AG
//  -------------------------------------------------------------------------
//  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_DCSMMETADATACREATOR_H
#define RAMSES_DCSMMETADATACREATOR_H
 
#include "ramses-framework-api/RamsesFrameworkTypes.h"
#include "ramses-framework-api/StatusObject.h"
#include "ramses-framework-api/CarModelViewMetadata.h"
#include <string>
 
namespace ramses
{
    class RAMSES_API DcsmMetadataCreator : public StatusObject
    {
    public:
        DcsmMetadataCreator();
 
        ~DcsmMetadataCreator();
 
        status_t setPreviewImagePng(const void* data, size_t dataLength);
 
        status_t setPreviewDescription(std::u32string previewDescription);
 
        status_t setWidgetOrder(int32_t widgetOrder);
 
        status_t setWidgetBackgroundID(int32_t backgroundID);
 
        status_t setWidgetHUDLineID(int32_t hudLineID);
 
        status_t setCarModel(int32_t carModel);
 
        status_t setCarModelView(const CarModelViewMetadata& viewMetadata, const AnimationInformation& timingInfo);
 
        status_t setCarModelViewExtended(const CarModelViewMetadataExtended& viewMetadata);
 
        status_t setCarModelVisibility(bool visibility);
 
        status_t setExclusiveBackground(bool state);
 
        status_t setStreamID(int32_t streamID);
 
        status_t setContentFlippedVertically(bool state);
 
        status_t setDisplayedDataFlags(uint32_t flags);
 
        status_t setLayoutAvailability(uint8_t flags);
 
        status_t setConfiguratorPriority(uint8_t priority);
 
        DcsmMetadataCreator(DcsmMetadataCreator&& other) = delete;
 
        DcsmMetadataCreator& operator=(DcsmMetadataCreator&& other) = delete;
 
        DcsmMetadataCreator(const DcsmMetadataCreator& other) = delete;
 
        DcsmMetadataCreator& operator=(const DcsmMetadataCreator& other) = delete;
 
        class DcsmMetadataCreatorImpl& impl;
    };
}
 
#endif