com.google.appinventor.components.runtime.OrientationSensor Class Reference

Inheritance diagram for com.google.appinventor.components.runtime.OrientationSensor:

Public Member Functions
	OrientationSensor (ComponentContainer container)
void	OrientationChanged (float azimuth, float pitch, float roll)
boolean	Available ()
boolean	Enabled ()
void	Enabled (boolean enabled)
float	Pitch ()
float	Roll ()
float	Azimuth ()
float	Angle ()
float	Magnitude ()
void	onSensorChanged (SensorEvent sensorEvent)
void	onAccuracyChanged (Sensor sensor, int accuracy)
void	onDelete ()
void	onPause ()
void	onResume ()
Public Member Functions inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
HandlesEventDispatching	getDispatchDelegate ()

Additional Inherited Members
Static Public Attributes inherited from com.google.appinventor.components.runtime.Component
static final String	ASSET_DIRECTORY = "component"
static final int	ALIGNMENT_NORMAL = 0
static final int	ALIGNMENT_CENTER = 1
static final int	ALIGNMENT_OPPOSITE = 2
static final int	ACCELEROMETER_SENSITIVITY_WEAK = 1
static final int	ACCELEROMETER_SENSITIVITY_MODERATE = 2
static final int	ACCELEROMETER_SENSITIVITY_STRONG = 3
static final int	BUTTON_SHAPE_DEFAULT = 0
static final int	BUTTON_SHAPE_ROUNDED = 1
static final int	BUTTON_SHAPE_RECT = 2
static final int	BUTTON_SHAPE_OVAL = 3
static final int	COLOR_NONE = 0x00FFFFFF
static final int	COLOR_BLACK = 0xFF000000
static final int	COLOR_BLUE = 0xFF0000FF
static final int	COLOR_CYAN = 0xFF00FFFF
static final int	COLOR_DKGRAY = 0xFF444444
static final int	COLOR_GRAY = 0xFF888888
static final int	COLOR_GREEN = 0xFF00FF00
static final int	COLOR_LTGRAY = 0xFFCCCCCC
static final int	COLOR_MAGENTA = 0xFFFF00FF
static final int	COLOR_ORANGE = 0xFFFFC800
static final int	COLOR_PINK = 0xFFFFAFAF
static final int	COLOR_RED = 0xFFFF0000
static final int	COLOR_WHITE = 0xFFFFFFFF
static final int	COLOR_YELLOW = 0xFFFFFF00
static final int	COLOR_DEFAULT = 0x00000000
static final String	DEFAULT_VALUE_COLOR_NONE = "&H00FFFFFF"
static final String	DEFAULT_VALUE_COLOR_BLACK = "&HFF000000"
static final String	DEFAULT_VALUE_COLOR_BLUE = "&HFF0000FF"
static final String	DEFAULT_VALUE_COLOR_CYAN = "&HFF00FFFF"
static final String	DEFAULT_VALUE_COLOR_DKGRAY = "&HFF444444"
static final String	DEFAULT_VALUE_COLOR_GRAY = "&HFF888888"
static final String	DEFAULT_VALUE_COLOR_GREEN = "&HFF00FF00"
static final String	DEFAULT_VALUE_COLOR_LTGRAY = "&HFFCCCCCC"
static final String	DEFAULT_VALUE_COLOR_MAGENTA = "&HFFFF00FF"
static final String	DEFAULT_VALUE_COLOR_ORANGE = "&HFFFFC800"
static final String	DEFAULT_VALUE_COLOR_PINK = "&HFFFFAFAF"
static final String	DEFAULT_VALUE_COLOR_RED = "&HFFFF0000"
static final String	DEFAULT_VALUE_COLOR_WHITE = "&HFFFFFFFF"
static final String	DEFAULT_VALUE_COLOR_YELLOW = "&HFFFFFF00"
static final String	DEFAULT_VALUE_COLOR_DEFAULT = "&H00000000"
static final float	FONT_DEFAULT_SIZE = 14
static final int	LAYOUT_ORIENTATION_HORIZONTAL = ComponentConstants.LAYOUT_ORIENTATION_HORIZONTAL
static final int	LAYOUT_ORIENTATION_VERTICAL = ComponentConstants.LAYOUT_ORIENTATION_VERTICAL
static final int	SCALING_SCALE_PROPORTIONALLY = 0
static final int	SCALING_SCALE_TO_FIT = 1
static final int	TYPEFACE_DEFAULT = 0
static final int	TYPEFACE_SANSSERIF = 1
static final int	TYPEFACE_SERIF = 2
static final int	TYPEFACE_MONOSPACE = 3
static final int	LENGTH_PREFERRED = -1
static final int	LENGTH_FILL_PARENT = -2
static final int	LENGTH_UNKNOWN = -3
static final int	LENGTH_PERCENT_TAG = -1000
static final int	TOAST_LENGTH_SHORT = 0
static final int	TOAST_LENGTH_LONG = 1
static final int	DIRECTION_NORTH = 1
static final int	DIRECTION_NORTHEAST = 2
static final int	DIRECTION_EAST = 3
static final int	DIRECTION_SOUTHEAST = 4
static final int	DIRECTION_SOUTH = -1
static final int	DIRECTION_SOUTHWEST = -2
static final int	DIRECTION_WEST = -3
static final int	DIRECTION_NORTHWEST = -4
static final int	DIRECTION_NONE = 0
static final int	DIRECTION_MIN = -4
static final int	DIRECTION_MAX = 4
static float	SLIDER_MIN_VALUE = 10
static float	SLIDER_MAX_VALUE = 50
static float	SLIDER_THUMB_VALUE = (SLIDER_MIN_VALUE + SLIDER_MAX_VALUE) / 2.0f
static final String	DEFAULT_VALUE_TEXT_TO_SPEECH_COUNTRY = ""
static final String	DEFAULT_VALUE_TEXT_TO_SPEECH_LANGUAGE = ""
Protected Member Functions inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
	AndroidNonvisibleComponent (Form form)
Protected Attributes inherited from com.google.appinventor.components.runtime.AndroidNonvisibleComponent
final Form	form

Detailed Description

Use an orientation sensor component to determine the phone's spatial orientation.

An orientation sensor is a non-visible component that reports the following three values, in degrees:

• Roll : 0 degree when the device is level, increasing to 90 degrees as the device is tilted up onto its left side, and decreasing to −90 degrees when the device is tilted up onto its right side.
• Pitch : 0 degree when the device is level, increasing to 90 degrees as the device is tilted so its top is pointing down, then decreasing to 0 degree as it gets turned over. Similarly, as the device is tilted so its bottom points down, pitch decreases to −90 degrees, then increases to 0 degree as it gets turned all the way over.
• Azimuth : 0 degree when the top of the device is pointing north, 90 degrees when it is pointing east, 180 degrees when it is pointing south, 270 degrees when it is pointing west, etc.

These measurements assume that the device itself is not moving.

Definition at line 76 of file OrientationSensor.java.

Constructor & Destructor Documentation

OrientationSensor()

com.google.appinventor.components.runtime.OrientationSensor.OrientationSensor

(

ComponentContainer

container

)

Creates a new OrientationSensor component.

Parameters

container

ignored (because this is a non-visible component)

Definition at line 120 of file OrientationSensor.java.

Member Function Documentation

Angle()

float com.google.appinventor.components.runtime.OrientationSensor.Angle

(

)

Returns an angle that tells the direction in which the device is tiled. That is, it tells the direction of the force that would be felt by a ball rolling on the surface of the device.

@internaldoc

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

Definition at line 272 of file OrientationSensor.java.

Available()

boolean com.google.appinventor.components.runtime.OrientationSensor.Available

(

)

Indicates whether the orientation sensor is present on the device.

Returns

true 

indicates that an orientation sensor is available,

false 

that it isn't

Definition at line 187 of file OrientationSensor.java.

Azimuth()

float com.google.appinventor.components.runtime.OrientationSensor.Azimuth

(

)

Returns the azimuth angle of the device. To return meaningful values the sensor must be enabled.

Returns

current azimuth

Definition at line 253 of file OrientationSensor.java.

Enabled() [1/2]

boolean com.google.appinventor.components.runtime.OrientationSensor.Enabled

(

)

Specifies whether the orientation sensor is enabled.

Returns

true 

indicates that the sensor generates events,

false 

that it doesn't

Definition at line 199 of file OrientationSensor.java.

Enabled() [2/2]

void com.google.appinventor.components.runtime.OrientationSensor.Enabled

(

boolean

enabled

)

Enabled property setter method.

Parameters

enabled

Definition at line 213 of file OrientationSensor.java.

Magnitude()

float com.google.appinventor.components.runtime.OrientationSensor.Magnitude

(

)

Returns a number between 0 and 1 indicating how much the device is tilted. It gives the magnitude of the force that would be felt by a ball rolling on the surface of the device. For the angle of tilt, use Angle().

@internaldoc

To return meaningful values the sensor must be enabled.

Returns

the magnitude of the tilt, from 0 to 1

Definition at line 310 of file OrientationSensor.java.

onAccuracyChanged()

void com.google.appinventor.components.runtime.OrientationSensor.onAccuracyChanged	(	Sensor	sensor,
		int	accuracy
	)

Definition at line 430 of file OrientationSensor.java.

onDelete()

void com.google.appinventor.components.runtime.OrientationSensor.onDelete

(

)

Implements com.google.appinventor.components.runtime.Deleteable.

Definition at line 437 of file OrientationSensor.java.

onPause()

void com.google.appinventor.components.runtime.OrientationSensor.onPause

(

)

Implements com.google.appinventor.components.runtime.OnPauseListener.

Definition at line 443 of file OrientationSensor.java.

onResume()

void com.google.appinventor.components.runtime.OrientationSensor.onResume

(

)

Implements com.google.appinventor.components.runtime.OnResumeListener.

Definition at line 449 of file OrientationSensor.java.

onSensorChanged()

void com.google.appinventor.components.runtime.OrientationSensor.onSensorChanged

(

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.

Parameters

sensorEvent

an event from the accelerometer or magnetic field sensor

Definition at line 356 of file OrientationSensor.java.

OrientationChanged()

void com.google.appinventor.components.runtime.OrientationSensor.OrientationChanged	(	float	azimuth,
		float	pitch,
		float	roll
	)

The OrientationChanged event handler is run when the orientation has changed.

@internaldoc 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.

Definition at line 174 of file OrientationSensor.java.

Pitch()

float com.google.appinventor.components.runtime.OrientationSensor.Pitch

(

)

Returns the pitch angle of the device. To return meaningful values the sensor must be enabled.

Returns

current pitch

Definition at line 231 of file OrientationSensor.java.

Roll()

float com.google.appinventor.components.runtime.OrientationSensor.Roll

(

)

Returns the roll angle of the device. To return meaningful values the sensor must be enabled.

Returns

current roll

Definition at line 242 of file OrientationSensor.java.

---

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

• C:/Users/Ulli/appinventor-sources/appinventor/components/src/com/google/appinventor/components/runtime/OrientationSensor.java