hebi::util::MobileIO Class Reference

#include <mobile_io.hpp>

Public Types
enum	ButtonMode { ButtonMode::Momentary = 0, ButtonMode::Toggle = 1 }
enum	ButtonState { ButtonState::ToOff = -1, ButtonState::Unchanged = 0, ButtonState::ToOn = 1 }

Public Member Functions
bool	update (int32_t timeout_ms=Group::DEFAULT_TIMEOUT_MS)
bool	resetUI (bool acknowledge_send=true)
bool	setAxisSnap (int axis_number, float snap_to, bool acknowledge_send=true)
bool	disableAxisSnap (int axis_number, bool acknowledge_send=true)
bool	setAxisValue (int axis_number, float value, bool acknowledge_send=true)
bool	setAxisLabel (int axis_number, const std::string &message, bool acknowledge_send=true)
bool	setButtonMode (int button_number, ButtonMode mode, bool acknowledge_send=true)
bool	setButtonLed (int button_number, bool on, bool acknowledge_send=true)
bool	setButtonLabel (int button_number, const std::string &message, bool acknowledge_send=true)
bool	setLedColor (uint8_t r, uint8_t g, uint8_t b, bool acknowledge_send=true)
bool	appendText (const std::string &message, bool acknowledge_send=true)
bool	clearText (bool acknowledge_send=true)
const hebi::Feedback &	getLastFeedback () const
const Vector3f	getArPosition () const
const Quaternionf	getArOrientation () const
float	getAxis (int axis) const
bool	getButton (int button) const
ButtonState	getButtonDiff (int button) const

Static Public Member Functions
static std::unique_ptr< MobileIO >	create (const std::string &family, const std::string &name)

Static Public Attributes
static constexpr size_t	NumButtons = 8

Member Enumeration Documentation

ButtonMode

enum hebi::util::MobileIO::ButtonMode

strong

Enumerator
Momentary
Toggle

ButtonState

enum hebi::util::MobileIO::ButtonState

strong

Enumerator
ToOff
Unchanged
ToOn

Member Function Documentation

create()

std::unique_ptr< MobileIO > hebi::util::MobileIO::create ( const std::string &  family, const std::string &  name  )

static

update()

bool hebi::util::MobileIO::update

(

int32_t

timeout_ms = Group::DEFAULT_TIMEOUT_MS

)

resetUI()

bool hebi::util::MobileIO::resetUI

(

bool

acknowledge_send = true

)

setAxisSnap()

bool hebi::util::MobileIO::setAxisSnap	(	int	axis_number,
		float	snap_to,
		bool	acknowledge_send = true
	)

disableAxisSnap()

bool hebi::util::MobileIO::disableAxisSnap ( int  axis_number, bool  acknowledge_send = true  )

inline

setAxisValue()

bool hebi::util::MobileIO::setAxisValue	(	int	axis_number,
		float	value,
		bool	acknowledge_send = true
	)

setAxisLabel()

bool hebi::util::MobileIO::setAxisLabel	(	int	axis_number,
		const std::string &	message,
		bool	acknowledge_send = true
	)

setButtonMode()

bool hebi::util::MobileIO::setButtonMode	(	int	button_number,
		ButtonMode	mode,
		bool	acknowledge_send = true
	)

setButtonLed()

bool hebi::util::MobileIO::setButtonLed	(	int	button_number,
		bool	on,
		bool	acknowledge_send = true
	)

setButtonLabel()

bool hebi::util::MobileIO::setButtonLabel	(	int	button_number,
		const std::string &	message,
		bool	acknowledge_send = true
	)

setLedColor()

bool hebi::util::MobileIO::setLedColor	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b,
		bool	acknowledge_send = true
	)

appendText()

bool hebi::util::MobileIO::appendText	(	const std::string &	message,
		bool	acknowledge_send = true
	)

clearText()

bool hebi::util::MobileIO::clearText

(

bool

acknowledge_send = true

)

getLastFeedback()

const hebi::Feedback& hebi::util::MobileIO::getLastFeedback ( ) const

inline

getArPosition()

const Vector3f hebi::util::MobileIO::getArPosition ( ) const

inline

getArOrientation()

const Quaternionf hebi::util::MobileIO::getArOrientation ( ) const

inline

getAxis()

float hebi::util::MobileIO::getAxis

(

int

axis

)

const

getButton()

bool hebi::util::MobileIO::getButton

(

int

button

)

const

getButtonDiff()

MobileIO::ButtonState hebi::util::MobileIO::getButtonDiff

(

int

button

)

const

Member Data Documentation

NumButtons

constexpr size_t hebi::util::MobileIO::NumButtons = 8

static

---

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

• mobile_io.hpp
• mobile_io.cpp