RAMSES Documentation  27.0.130
Information for RAMSES users and developers
DcsmMetadataUpdate.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2019 BMW AG
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_DCSMMETADATAUPDATE_H
10 #define RAMSES_DCSMMETADATAUPDATE_H
11 
15 #include <string>
16 #include <vector>
17 
18 namespace ramses
19 {
20  class DcsmMetadataUpdateImpl;
21 
31  {
32  public:
35 
41  bool hasPreviewImagePng() const;
42 
50  std::vector<unsigned char> getPreviewImagePng() const;
51 
57  bool hasPreviewDescription() const;
58 
65  std::u32string getPreviewDescription() const;
66 
72  bool hasWidgetOrder() const;
73 
80  int32_t getWidgetOrder() const;
81 
87  bool hasWidgetBackgroundID() const;
88 
95  int32_t getWidgetBackgroundID() const;
96 
102  bool hasWidgetHUDLineID() const;
103 
110  int32_t getWidgetHUDLineID() const;
111 
117  bool hasCarModel() const;
118 
125  int32_t getCarModel() const;
126 
132  bool hasCarModelView() const;
133 
141 
148 
156 
164 
170  bool hasCarModelVisibility() const;
171 
178  bool getCarModelVisibility() const;
179 
186 
194 
200  bool hasStreamID() const;
201 
208  int32_t getStreamID() const;
209 
215  bool hasDisplayedDataFlags() const;
216 
223  uint32_t getDisplayedDataFlags() const;
224 
231 
241 
247  bool hasLayoutAvailability() const;
248 
255  uint8_t getLayoutAvailability() const;
256 
263 
270  uint8_t getConfiguratorPriority() const;
271 
275  DcsmMetadataUpdate() = delete;
276 
281  explicit DcsmMetadataUpdate(DcsmMetadataUpdateImpl& impl_);
282 
288 
295 
300  DcsmMetadataUpdate(const DcsmMetadataUpdate& other) = delete;
301 
308 
312  DcsmMetadataUpdateImpl& impl;
313  };
314 }
315 
316 #endif
#define RAMSES_API
Definition: APIExport.h:35
Class to extract DCSM metadata entries from. Objects of this type will be provided by ramses callback...
Definition: DcsmMetadataUpdate.h:31
bool hasCarModelVisibility() const
Check if object contains car model visibility metadata entry.
bool getExclusiveBackground() const
Get exclusive background metadata entry. Value is undefined when not hasExclusiveBackground().
AnimationInformation getCarModelViewAnimationInfo() const
Get animation information associated with car model view metadata entry. Value is undefined when not ...
bool hasCarModelView() const
Check if object contains car model view metadata entry.
std::u32string getPreviewDescription() const
Get preview description metadata entry as utf32 string. Will be empty when not hasPreviewDescription(...
uint8_t getLayoutAvailability() const
Get layout availability metadata entry. Value is undefined when not hasLayoutAvailability().
bool hasExclusiveBackground() const
Check if object contains exclusive background metadata entry.
bool hasPreviewDescription() const
Check if object contains preview description metadata entry.
int32_t getWidgetOrder() const
Get widget order metadata entry. Value is undefined when not hasWidgetOrder().
DcsmMetadataUpdate & operator=(DcsmMetadataUpdate &&other)=delete
Deleted move assignment.
bool hasWidgetHUDLineID() const
Check if object contains widget hud line id metadata entry.
~DcsmMetadataUpdate()
Destructor.
DcsmMetadataUpdate(DcsmMetadataUpdate &&other)=delete
Deleted move constructor.
bool hasConfiguratorPriority() const
Check if object contains configuratorPriority metadata entry.
DcsmMetadataUpdate(DcsmMetadataUpdateImpl &impl_)
Constructor from impl.
bool hasPreviewImagePng() const
Check if object contains PNG preview image metadata entry.
bool getContentFlippedVertically() const
Get contentFlippedVertically metadata entry. Value is undefined when not hasContentFlippedVertically(...
CarModelViewMetadataExtended getCarModelViewExtended() const
Get car model view extended metadata entry. Value is undefined when not hasCarModelViewExtended().
bool hasWidgetBackgroundID() const
Check if object contains widget background id metadata entry.
uint8_t getConfiguratorPriority() const
Get the widget configurator priority for this dcsm content Value is undefined if not hasConfiguratorP...
int32_t getStreamID() const
Get streamID metadata entry. Value is undefined when not hasStreamID().
int32_t getWidgetHUDLineID() const
Get widget hud line id metadata entry. Value is undefined when not hasWidgetHUDLineID().
DcsmMetadataUpdate()=delete
Deleted default constructor.
CarModelViewMetadata getCarModelView() const
Get car model view metadata entry. Value is undefined when not hasCarModelView().
bool hasCarModelViewExtended() const
Check if object contains car model view extended metadata entry.
DcsmMetadataUpdateImpl & impl
Definition: DcsmMetadataUpdate.h:312
bool hasDisplayedDataFlags() const
Check if object contains displayed data flags metadata entry.
bool hasCarModel() const
Check if object contains car model metadata entry.
int32_t getCarModel() const
Get car model metadata entry. Value is undefined when not hasCarModel().
bool hasWidgetOrder() const
Check if object contains widget order metadata entry.
uint32_t getDisplayedDataFlags() const
Get displayed data flags. Value is undefined when not hasDisplayedDataFlags().
DcsmMetadataUpdate & operator=(const DcsmMetadataUpdate &other)=delete
Deleted copy assignment.
bool hasContentFlippedVertically() const
Check if object contains a contentFlippedVertically entry.
std::vector< unsigned char > getPreviewImagePng() const
Get preview image metadata entry. The vector contains in memory representation of a PNG file....
int32_t getWidgetBackgroundID() const
Get widget background id metadata entry. Value is undefined when not hasWidgetBackgroundID().
bool hasLayoutAvailability() const
Check if object contains layoutAvailability metadata entry.
bool hasStreamID() const
Check if object contains streamID metadata entry.
DcsmMetadataUpdate(const DcsmMetadataUpdate &other)=delete
Deleted copy constructor.
bool getCarModelVisibility() const
Get car model visibility metadata entry. Value is undefined when not hasCarModelVisibility().
The StatusObject provides status message handling.
Definition: StatusObject.h:22
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15
Definition: DcsmApiTypes.h:152
Struct containing extended metadata about car model views It's an extension for CarModelViewMetadata.
Definition: CarModelViewMetadata.h:75
Struct containing metadata about car model views.
Definition: CarModelViewMetadata.h:20