blip  0.1
Public Types | Public Member Functions | List of all members
RotationVectorSensorEvent Class Reference

A rotation vector sensor event, which measures orientation in 3D space. More...

#include <RotationVectorSensorEvent.hpp>

Inheritance diagram for RotationVectorSensorEvent:
Inheritance graph
[legend]

Public Types

enum  Type { Type_Key, Type_Motion, Type_Sensor, Type_Timer }
 Event types. More...
 

Public Member Functions

virtual ~RotationVectorSensorEvent ()
 Destructor. More...
 
Accuracy getAccuracy () const
 Get the accuracy of the sensor event values. More...
 
float getValue (int index) const throw ()
 Get a sensor value. More...
 
virtual time_ms_t getEventTime () const
 Get the time at which this event occurred. More...
 
Sensor::Type getSensorType () const
 Get the sensor type. More...
 
Type getType () const
 Get the event type. More...
 

Detailed Description

A rotation vector sensor event, which measures orientation in 3D space.

All values are unitless, and are defined as follows:

  • value 0: x * sin(theta / 2)
  • value 1: y * sin(theta / 2)
  • value 2: z * sin(theta / 2)
  • value 3: cos(theta / 2) (optional)
Author
Mark Lindner

Member Enumeration Documentation

◆ Type

enum Type
inherited

Event types.

Enumerator
Type_Key 

Key input events.

Type_Motion 

Motion input events.

Type_Sensor 

Sensor events.

Type_Timer 

Timer events.

Constructor & Destructor Documentation

◆ ~RotationVectorSensorEvent()

~RotationVectorSensorEvent ( )
virtual

Destructor.

Member Function Documentation

◆ getAccuracy()

Accuracy getAccuracy ( ) const
inlineinherited

Get the accuracy of the sensor event values.

◆ getEventTime()

virtual time_ms_t getEventTime ( ) const
inlinevirtualinherited

Get the time at which this event occurred.

Implements Event.

◆ getSensorType()

Sensor::Type getSensorType ( ) const
inlineinherited

Get the sensor type.

◆ getType()

Type getType ( ) const
inlineinherited

Get the event type.

◆ getValue()

float getValue ( int  index) const
throw (
)
inherited

Get a sensor value.

Parameters
indexThe value index. Must be between 0 and 15, inclusive. The number of significant values, and the meaning of each, is dependent on the sensor type.
Returns
The sensor value.
The documentation for this class was generated from the following files: