tiltfive::Wand Class Reference

Represents an abstract instance of a Tilt Five™ wand Used with tiltfive::WandStreamHelper. More...

#include <TiltFiveNative.hpp>

Public Member Functions
auto	getLatestReport () const -> Result< T5_WandReport >
	Get the latest wand report for this wand. More...
auto	sendImpulse (float amplitude, uint16_t duration) const -> Result< void >
	Send an impulse to this wand. More...
T5_WandHandle	handle () const
	Get the wand handle. More...

Detailed Description

Represents an abstract instance of a Tilt Five™ wand Used with tiltfive::WandStreamHelper.

Definition at line 1337 of file TiltFiveNative.hpp.

Member Function Documentation

getLatestReport()

auto tiltfive::Wand::getLatestReport ( ) const -> Result<T5_WandReport>

inline

Get the latest wand report for this wand.

Definition at line 1362 of file TiltFiveNative.hpp.

handle()

T5_WandHandle tiltfive::Wand::handle ( ) const

inline

Get the wand handle.

Definition at line 1374 of file TiltFiveNative.hpp.

sendImpulse()

auto tiltfive::Wand::sendImpulse ( float  amplitude, uint16_t  duration  ) const -> Result<void>

inline

Send an impulse to this wand.

Parameters

amplitude	- The amplitude of the impulse, between (0.0 and 1.0].
duration	- The duration, in ms, of the impulse. Must be between 1 and 320ms.

Definition at line 1369 of file TiltFiveNative.hpp.

---

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

• TiltFiveNative.hpp