com.google.appinventor.components.runtime

Class OrientationSensor

java.lang.Object

com.google.appinventor.components.runtime.AndroidNonvisibleComponent

com.google.appinventor.components.runtime.OrientationSensor

All Implemented Interfaces:

android.hardware.SensorEventListener, Component, Deleteable, OnPauseListener, OnResumeListener

public class OrientationSensor
extends AndroidNonvisibleComponent
implements android.hardware.SensorEventListener, Deleteable, OnPauseListener, OnResumeListener

Sensor that can measure absolute orientation in 3 dimensions.

Field Summary

Fields inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

form

Fields inherited from interface com.google.appinventor.components.runtime.Component

ACCELEROMETER_SENSITIVITY_MODERATE, ACCELEROMETER_SENSITIVITY_STRONG, ACCELEROMETER_SENSITIVITY_WEAK, ALIGNMENT_CENTER, ALIGNMENT_NORMAL, ALIGNMENT_OPPOSITE, ASSET_DIRECTORY, BUTTON_SHAPE_DEFAULT, BUTTON_SHAPE_OVAL, BUTTON_SHAPE_RECT, BUTTON_SHAPE_ROUNDED, COLOR_BLACK, COLOR_BLUE, COLOR_CYAN, COLOR_DEFAULT, COLOR_DKGRAY, COLOR_GRAY, COLOR_GREEN, COLOR_LTGRAY, COLOR_MAGENTA, COLOR_NONE, COLOR_ORANGE, COLOR_PINK, COLOR_RED, COLOR_WHITE, COLOR_YELLOW, DEFAULT_VALUE_COLOR_BLACK, DEFAULT_VALUE_COLOR_BLUE, DEFAULT_VALUE_COLOR_CYAN, DEFAULT_VALUE_COLOR_DEFAULT, DEFAULT_VALUE_COLOR_DKGRAY, DEFAULT_VALUE_COLOR_GRAY, DEFAULT_VALUE_COLOR_GREEN, DEFAULT_VALUE_COLOR_LTGRAY, DEFAULT_VALUE_COLOR_MAGENTA, DEFAULT_VALUE_COLOR_NONE, DEFAULT_VALUE_COLOR_ORANGE, DEFAULT_VALUE_COLOR_PINK, DEFAULT_VALUE_COLOR_RED, DEFAULT_VALUE_COLOR_WHITE, DEFAULT_VALUE_COLOR_YELLOW, DIRECTION_EAST, DIRECTION_MAX, DIRECTION_MIN, DIRECTION_NONE, DIRECTION_NORTH, DIRECTION_NORTHEAST, DIRECTION_NORTHWEST, DIRECTION_SOUTH, DIRECTION_SOUTHEAST, DIRECTION_SOUTHWEST, DIRECTION_WEST, FONT_DEFAULT_SIZE, LAYOUT_ORIENTATION_HORIZONTAL, LAYOUT_ORIENTATION_VERTICAL, LENGTH_FILL_PARENT, LENGTH_PREFERRED, LENGTH_UNKNOWN, SLIDER_MAX_VALUE, SLIDER_MIN_VALUE, SLIDER_THUMB_VALUE, TOAST_LENGTH_LONG, TOAST_LENGTH_SHORT, TYPEFACE_DEFAULT, TYPEFACE_MONOSPACE, TYPEFACE_SANSSERIF, TYPEFACE_SERIF

Constructor Summary

Constructors

Constructor and Description
OrientationSensor(ComponentContainer container) Creates a new OrientationSensor component.

Method Summary

Methods

Modifier and Type	Method and Description
float	Angle() Angle property getter method (read-only property).
boolean	Available() Available property getter method (read-only property).
float	Azimuth() Azimuth property getter method (read-only property).
boolean	Enabled() Enabled property getter method.
void	Enabled(boolean enabled) Enabled property setter method.
float	Magnitude() Magnitude property getter method (read-only property).
void	onAccuracyChanged(android.hardware.Sensor sensor, int accuracy)
void	onDelete()
void	onPause()
void	onResume()
void	onSensorChanged(android.hardware.SensorEvent sensorEvent) Responds to changes in the accelerometer or magnetic field sensors to recompute orientation.
void	OrientationChanged(float azimuth, float pitch, float roll) Default OrientationChanged event handler.
float	Pitch() Pitch property getter method (read-only property).
float	Roll() Roll property getter method (read-only property).

Methods inherited from class com.google.appinventor.components.runtime.AndroidNonvisibleComponent

getDispatchDelegate

Methods inherited from class java.lang.Object

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

Constructor Detail

OrientationSensor

public OrientationSensor(ComponentContainer container)

Creates a new OrientationSensor component.

Parameters:

container - ignored (because this is a non-visible component)

Method Detail

OrientationChanged

public void OrientationChanged(float azimuth,
                      float pitch,
                      float roll)

Default OrientationChanged event handler.

This event is signalled when the device's orientation has changed. It reports the new values of azimuth, pich, and roll, and it also sets the Azimuth, Pitch, and roll properties.

Azimuth is the compass heading in degrees, pitch indicates how the device is tilted from top to bottom, and roll indicates how much the device is tilted from side to side.

Available

public boolean Available()

Available property getter method (read-only property).

Returns:

true indicates that an orientation sensor is available, false that it isn't

Enabled

public boolean Enabled()

Enabled property getter method.

Returns:

true indicates that the sensor generates events, false that it doesn't

Enabled

public void Enabled(boolean enabled)

Enabled property setter method.

Parameters:

enabled - true enables sensor event generation, false disables it

Pitch

public float Pitch()

Pitch property getter method (read-only property).

To return meaningful values the sensor must be enabled.

Returns:

current pitch

Roll

public float Roll()

Roll property getter method (read-only property).

To return meaningful values the sensor must be enabled.

Returns:

current roll

Azimuth

public float Azimuth()

Azimuth property getter method (read-only property).

To return meaningful values the sensor must be enabled.

Returns:

current azimuth

Angle

public float Angle()

Angle property getter method (read-only property). Specifically, this provides the angle in which the orientation sensor is tilted, treating -Roll() as the x-coordinate and Pitch() as the y-coordinate. For the amount of the tilt, use Magnitude().

To return meaningful values the sensor must be enabled.

Returns:

the angle in degrees

Magnitude

public float Magnitude()

Magnitude property getter method (read-only property). Specifically, this returns a number between 0 and 1, indicating how much the device is tilted. For the angle of tilt, use Angle().

To return meaningful values the sensor must be enabled.

Returns:

the magnitude of the tilt, from 0 to 1

onSensorChanged

public void onSensorChanged(android.hardware.SensorEvent sensorEvent)

Responds to changes in the accelerometer or magnetic field sensors to recompute orientation. This only updates azimuth, pitch, and roll and raises the OrientationChanged event if both sensors have reported in at least once.

Specified by:

onSensorChanged in interface android.hardware.SensorEventListener

Parameters:

sensorEvent - an event from the accelerometer or magnetic field sensor

onAccuracyChanged

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

Specified by:

onAccuracyChanged in interface android.hardware.SensorEventListener

onDelete

public void onDelete()

Specified by:

onDelete in interface Deleteable

onPause

public void onPause()

Specified by:

onPause in interface OnPauseListener

onResume

public void onResume()

Specified by:

onResume in interface OnResumeListener