uk.ac.newcastle.team22.usb.navigation

Class Compass

java.lang.Object

uk.ac.newcastle.team22.usb.navigation.Compass

All Implemented Interfaces:

android.hardware.SensorEventListener

public class Compass
extends java.lang.Object
implements android.hardware.SensorEventListener

A class to provide compass functionality. Code has been altered for use in this project.

Version:

1.0

Author:

Viacheslav Iutin - https://github.com/iutinvg/compass - See Compass_License.txt, Daniel Vincent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Compass.CompassListener An interface which defines a listener for compass changes.

Constructor Summary

Constructors

Constructor and Description
Compass(android.content.Context context)

Method Summary

Modifier and Type	Method and Description
void	onAccuracyChanged(android.hardware.Sensor sensor, int accuracy)
void	onSensorChanged(android.hardware.SensorEvent event)
void	setAzimuthOffset(int offset) Used to alter the heading users should face.
void	setListener(Compass.CompassListener l) Sets the compass listener.
void	start() Starts the sensor listener.
void	stop() Stops the sensor listener.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Compass

public Compass(android.content.Context context)

Method Detail

start

public void start()

Starts the sensor listener.

stop

public void stop()

Stops the sensor listener.

onSensorChanged

public void onSensorChanged(android.hardware.SensorEvent event)

Specified by:

onSensorChanged in interface android.hardware.SensorEventListener

setAzimuthOffset

public void setAzimuthOffset(int offset)

Used to alter the heading users should face.

Parameters:

offset - heading the user should face in degrees.

setListener

public void setListener(Compass.CompassListener l)

Sets the compass listener.

Parameters:

l - The compass listener.

onAccuracyChanged

public void onAccuracyChanged(android.hardware.Sensor sensor,
                              int accuracy)

Specified by:

onAccuracyChanged in interface android.hardware.SensorEventListener