Bind
C++ UI toolkit for Arduino
 
Loading...
Searching...
No Matches
BindHeadingIndicator Class Reference

Represents a heading indicator for BindCanvas. More...

#include <BindHeadingIndicator.hpp>

Inheritance diagram for BindHeadingIndicator:
BindView

Public Member Functions

uint16_t getBytes (uint8_t *out) override
 Generates and returns the byte data representing the heading indicator configuration.
 

Public Attributes

int16_t x = 0
 X-coordinate position of the heading indicator.
 
int16_t y = 0
 Y-coordinate position of the heading indicator.
 
uint8_t cmdId = 0
 Command ID for the heading indicator. See the notes for possible cmdId values.
 
int16_t dimSize = 200
 Size dimension of the heading indicator (Width = Height).
 
float heading = 0.0f
 Current heading value.
 
- Public Attributes inherited from BindView
int16_t tag
 

Detailed Description

Represents a heading indicator for BindCanvas.

BindHeadingIndicator

The BindHeadingIndicator class is designed to create and display a heading indicator element within a BindCanvas screen. This element allows users to visualize and monitor a vehicle or an object's heading.

Note
Possible cmdId values for a BindView and corresponding effects:
  • BIND_ADD_OR_REFRESH_CMD: Adds the object to the canvas (screen) or refreshes the existing one.
  • BIND_DATA_ONLY_CMD: Refreshes the existing object without moving or resizing; updates data, such as text.
  • BIND_REMOVE_CMD: Removes the object from the canvas (screen).
  • BIND_DISABLE_CMD: Disables the object.
  • BIND_ENABLE_CMD: Enables the object.
  • BIND_HIDE_CMD: Hides the object.
  • BIND_VISIBLE_CMD: Restores the object's visibility.

Member Function Documentation

◆ getBytes()

uint16_t BindHeadingIndicator::getBytes ( uint8_t *  out)
inlineoverridevirtual

Generates and returns the byte data representing the heading indicator configuration.

This function is meant for internal use by the Bind framework and should not be called directly by users. It serializes the heading indicator's configuration properties into a byte array for communication with BindCanvas.

Parameters
outPointer to the output byte array.
Returns
The number of bytes written to the output array.

Reimplemented from BindView.


The documentation for this class was generated from the following files: