Update of information about a DCSM category. Contains information like changes in size. Objects of this type will be provided by ramses callbacks and are used to give information on consumer side. Do not reuse objects on consumer side, since they track changes and would transmit these again if reused.
More...
#include <CategoryInfoUpdate.h>
|
| CategoryInfoUpdateImpl & | impl |
| |
| class StatusObjectImpl & | impl |
| |
Update of information about a DCSM category. Contains information like changes in size. Objects of this type will be provided by ramses callbacks and are used to give information on consumer side. Do not reuse objects on consumer side, since they track changes and would transmit these again if reused.
The object can be queried for all available data and when available can be extracted. See IDcsmProviderEventHandler::contentSizeChange() for more details.
- Examples
- ramses-example-dcsm-provider/src/main.cpp.
◆ Layout
The possible layout values in the instrument cluster.
| Enumerator |
|---|
| Drive | |
| Focus | |
| Gallery | |
| Autonomous | |
| Sport_Road | |
| Sport_Track | |
◆ CategoryInfoUpdate() [1/7]
| ramses::CategoryInfoUpdate::CategoryInfoUpdate |
( |
| ) |
|
Default constructor with no data set.
◆ CategoryInfoUpdate() [2/7]
| ramses::CategoryInfoUpdate::CategoryInfoUpdate |
( |
SizeInfo |
renderSize, |
|
|
Rect |
categoryRect, |
|
|
Rect |
safeRect, |
|
|
Layout |
layout |
|
) |
| |
constructor for CategoryInfoUpdate
- Parameters
-
| renderSize | the new render size |
| categoryRect | the new category rect |
| safeRect | the new safe rect |
| layout | the new active layout |
◆ CategoryInfoUpdate() [3/7]
| ramses::CategoryInfoUpdate::CategoryInfoUpdate |
( |
SizeInfo |
renderSize, |
|
|
Rect |
categoryRect, |
|
|
Rect |
safeRect |
|
) |
| |
constructor for CategoryInfoUpdate
- Parameters
-
| renderSize | the new render size |
| categoryRect | the new category rect |
| safeRect | the new safe rect |
◆ CategoryInfoUpdate() [4/7]
| ramses::CategoryInfoUpdate::CategoryInfoUpdate |
( |
SizeInfo |
renderSize, |
|
|
Rect |
categoryRect |
|
) |
| |
constructor for CategoryInfoUpdate
- Parameters
-
| renderSize | the new render size |
| categoryRect | the new category rect |
◆ ~CategoryInfoUpdate()
| ramses::CategoryInfoUpdate::~CategoryInfoUpdate |
( |
| ) |
|
◆ CategoryInfoUpdate() [5/7]
| ramses::CategoryInfoUpdate::CategoryInfoUpdate |
( |
CategoryInfoUpdateImpl & |
impl_ | ) |
|
|
explicit |
Constructor from impl.
- Parameters
-
◆ CategoryInfoUpdate() [6/7]
Deleted move constructor.
- Parameters
-
◆ CategoryInfoUpdate() [7/7]
Deleted copy constructor.
- Parameters
-
◆ getActiveLayout()
| Layout ramses::CategoryInfoUpdate::getActiveLayout |
( |
| ) |
const |
◆ getCategoryRect()
| Rect ramses::CategoryInfoUpdate::getCategoryRect |
( |
| ) |
const |
◆ getRenderSize()
| SizeInfo ramses::CategoryInfoUpdate::getRenderSize |
( |
| ) |
const |
◆ getSafeRect()
| Rect ramses::CategoryInfoUpdate::getSafeRect |
( |
| ) |
const |
Get new safe rect. Only valid when hasSafeRectUpdate().
- Returns
- rectangle describing the safe dimensions
◆ hasActiveLayoutUpdate()
| bool ramses::CategoryInfoUpdate::hasActiveLayoutUpdate |
( |
| ) |
const |
Check if object contains active layout update.
- Returns
- true when has active layout update, false when not.
◆ hasCategoryRectUpdate()
| bool ramses::CategoryInfoUpdate::hasCategoryRectUpdate |
( |
| ) |
const |
Check if object contains category rect update.
- Returns
- true when has category rect update, false when not
◆ hasRenderSizeUpdate()
| bool ramses::CategoryInfoUpdate::hasRenderSizeUpdate |
( |
| ) |
const |
Check if object contains render size update.
- Returns
- true when has render size update, false when not
◆ hasSafeRectUpdate()
| bool ramses::CategoryInfoUpdate::hasSafeRectUpdate |
( |
| ) |
const |
Check if object contains safe rect update.
- Returns
- true when has safe rect update, false when not
◆ operator!=()
The inequality comparison operator.
- Parameters
-
| rhs | The instance to compare to |
- Returns
- True if not same, false otherwise
◆ operator=() [1/2]
Deleted move assignment.
- Parameters
-
- Returns
- unused
◆ operator=() [2/2]
Deleted copy assignment.
- Parameters
-
- Returns
- unused
◆ operator==()
The equality comparison operator.
- Parameters
-
| rhs | The instance to compare to |
- Returns
- True if same, false otherwise
◆ setActiveLayout()
Set new active layout.
- Parameters
-
| layout | The currently active layout. |
The active layout provides information about the overall layout of the contents on the consumer side. Depending on the layout, provider might want to provide different visuals for his contents.
- Returns
- StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().
◆ setCategoryRect()
| status_t ramses::CategoryInfoUpdate::setCategoryRect |
( |
Rect |
rect | ) |
|
Set new category rect.
Defined as rectangle inside render size (offsetX, offsetY, width, height). The offset is relative to lower left corner of render size. This is the area where the content should be. It is OK if you render content outside of category rect, but such content will not be visible in the rendered result (except potentially during layout size transition).
- Parameters
-
| rect | rectangle describing the new category dimensions |
- Returns
- StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().
◆ setRenderSize()
Set new render size.
Defined as width and height. This can be thought of as the 'canvas' (display or offscreen render target) where content will be rendered.
- Parameters
-
| sizeInfo | the new render size |
- Returns
- StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().
◆ setSafeRect()
| status_t ramses::CategoryInfoUpdate::setSafeRect |
( |
Rect |
rect | ) |
|
Set new safe rect.
- Parameters
-
| rect | rectangle describing the new safe dimensions |
Defined as rectangle relative to render size (offsetX, offsetY, width, height). The offset is relative to lower left corner of render size. This is just a hint from consumer which gives some guarantee that safe rect is not covered by any other UI element on the display (if content actively shown).
- Returns
- StatusOK for success, otherwise the returned status can be used to resolve error message using getStatusMessage().
◆ impl
| CategoryInfoUpdateImpl& ramses::CategoryInfoUpdate::impl |
Stores internal data for implementation specifics of CategoryInfo
The documentation for this class was generated from the following file:
- /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/CategoryInfoUpdate.h
Public Member Functions inherited from ramses::StatusObject
1.9.1