onboardapi  9.10.0
by Rheinmetall
M_HidDisplay::ConfigAxisLabel Struct Reference

Public Member Functions

 ConfigAxisLabel ()
 
 ConfigAxisLabel (uint32_t KeyAxisIndex, std::string const &NegativeLabel, M_Common::ImageType const &NegativeImage, std::string const &PositiveLabel, M_Common::ImageType const &PositiveImage, bool IsRemoved)
 

Public Attributes

uint32_t KeyAxisIndex
 Index identifying the axis. More...
 
std::string NegativeLabel
 Label to display for the negative axis. More...
 
M_Common::ImageType NegativeImage
 Image to display for the negative axis. More...
 
std::string PositiveLabel
 Label to display for the positive axis. More...
 
M_Common::ImageType PositiveImage
 Image to display for the positive axis. More...
 
bool IsRemoved
 

Detailed Description

Config to set the label and image to be displayed for an axis. Note: This function is only relevant for input devices which can display this kind of information.

Constructor & Destructor Documentation

◆ ConfigAxisLabel() [1/2]

M_HidDisplay::ConfigAxisLabel::ConfigAxisLabel ( )

◆ ConfigAxisLabel() [2/2]

M_HidDisplay::ConfigAxisLabel::ConfigAxisLabel ( uint32_t  KeyAxisIndex,
std::string const &  NegativeLabel,
M_Common::ImageType const &  NegativeImage,
std::string const &  PositiveLabel,
M_Common::ImageType const &  PositiveImage,
bool  IsRemoved 
)

Member Data Documentation

◆ IsRemoved

bool M_HidDisplay::ConfigAxisLabel::IsRemoved

Indicates if the payload is no longer available Note: This will always be set to true when the instance has been shut down After this has been set to true, the payload will no longer be available to late joiners.

◆ KeyAxisIndex

uint32_t M_HidDisplay::ConfigAxisLabel::KeyAxisIndex

Index identifying the axis.

◆ NegativeImage

M_Common::ImageType M_HidDisplay::ConfigAxisLabel::NegativeImage

Image to display for the negative axis.

◆ NegativeLabel

std::string M_HidDisplay::ConfigAxisLabel::NegativeLabel

Label to display for the negative axis.

◆ PositiveImage

M_Common::ImageType M_HidDisplay::ConfigAxisLabel::PositiveImage

Image to display for the positive axis.

◆ PositiveLabel

std::string M_HidDisplay::ConfigAxisLabel::PositiveLabel

Label to display for the positive axis.