AI2 Component  (Version nb184)
com.google.appinventor.components.runtime.AccelerometerSensor Class Reference
Inheritance diagram for com.google.appinventor.components.runtime.AccelerometerSensor:
com.google.appinventor.components.runtime.AndroidNonvisibleComponent com.google.appinventor.components.runtime.OnPauseListener com.google.appinventor.components.runtime.OnResumeListener com.google.appinventor.components.runtime.SensorComponent com.google.appinventor.components.runtime.Deleteable com.google.appinventor.components.runtime.Component com.google.appinventor.components.runtime.Component

Public Member Functions

 AccelerometerSensor (ComponentContainer container)
 
int MinimumInterval ()
 
void MinimumInterval (int interval)
 
int Sensitivity ()
 
void Sensitivity (int sensitivity)
 
void AccelerationChanged (float xAccel, float yAccel, float zAccel)
 
int getDeviceDefaultOrientation ()
 
void Shaking ()
 
boolean Available ()
 
boolean Enabled ()
 
void Enabled (boolean enabled)
 
float XAccel ()
 
float YAccel ()
 
float ZAccel ()
 
void LegacyMode (boolean legacyMode)
 
boolean LegacyMode ()
 
void onSensorChanged (SensorEvent sensorEvent)
 
void onAccuracyChanged (Sensor sensor, int accuracy)
 
void onResume ()
 
void onPause ()
 
void onDelete ()
 
- 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

Non-visible component that can detect shaking and measure acceleration approximately in three dimensions using SI units (m/s2). The components are:

  • xAccel: 0 when the phone is at rest on a flat surface, positive when the phone is tilted to the right (i.e., its left side is raised), and negative when the phone is tilted to the left (i.e., its right size is raised).
  • yAccel: 0 when the phone is at rest on a flat surface, positive when its bottom is raised, and negative when its top is raised.
  • zAccel: Equal to -9.8 (earth's gravity in meters per second per second when the device is at rest parallel to the ground with the display facing up, 0 when perpendicular to the ground, and +9.8 when facing down. The value can also be affected by accelerating it with or against gravity.

@internaldoc Physical world component that can detect shaking and measure acceleration in three dimensions. It is implemented using android.hardware.SensorListener (http://developer.android.com/reference/android/hardware/SensorListener.html).

From the Android documentation: "Sensor values are acceleration in the X, Y and Z axis, where the X axis has positive direction toward the right side of the device, the Y axis has positive direction toward the top of the device and the Z axis has positive direction toward the front of the device. The direction of the force of gravity is indicated by acceleration values in the X, Y and Z axes. The typical case where the device is flat relative to the surface of the Earth appears as -STANDARD_GRAVITY in the Z axis and X and Y values close to zero. Acceleration values are given in SI units (m/s^2)."

Definition at line 91 of file AccelerometerSensor.java.

Constructor & Destructor Documentation

◆ AccelerometerSensor()

com.google.appinventor.components.runtime.AccelerometerSensor.AccelerometerSensor ( ComponentContainer  container)

Creates a new AccelerometerSensor component.

Parameters
containerignored (because this is a non-visible component)

Definition at line 145 of file AccelerometerSensor.java.

Member Function Documentation

◆ AccelerationChanged()

void com.google.appinventor.components.runtime.AccelerometerSensor.AccelerationChanged ( float  xAccel,
float  yAccel,
float  zAccel 
)

Indicates the acceleration changed in the X, Y, and/or Z dimensions.

Definition at line 232 of file AccelerometerSensor.java.

◆ Available()

boolean com.google.appinventor.components.runtime.AccelerometerSensor.Available ( )

Returns whether the AccelerometerSensor hardware is available on the device.

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

Definition at line 295 of file AccelerometerSensor.java.

◆ Enabled() [1/2]

boolean com.google.appinventor.components.runtime.AccelerometerSensor.Enabled ( )

If true, the sensor will generate events. Otherwise, no events are generated even if the device is accelerated or shaken.

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

Definition at line 309 of file AccelerometerSensor.java.

◆ Enabled() [2/2]

void com.google.appinventor.components.runtime.AccelerometerSensor.Enabled ( boolean  enabled)

Specifies whether the sensor should generate events. If true{:.logic.block}, the sensor will generate events. Otherwise, no events are generated even if the device is accelerated or shaken.

Parameters
enabled

Definition at line 347 of file AccelerometerSensor.java.

◆ getDeviceDefaultOrientation()

int com.google.appinventor.components.runtime.AccelerometerSensor.getDeviceDefaultOrientation ( )

Definition at line 254 of file AccelerometerSensor.java.

◆ LegacyMode() [1/2]

boolean com.google.appinventor.components.runtime.AccelerometerSensor.LegacyMode ( )

Definition at line 449 of file AccelerometerSensor.java.

◆ LegacyMode() [2/2]

void com.google.appinventor.components.runtime.AccelerometerSensor.LegacyMode ( boolean  legacyMode)

Definition at line 445 of file AccelerometerSensor.java.

◆ MinimumInterval() [1/2]

int com.google.appinventor.components.runtime.AccelerometerSensor.MinimumInterval ( )

Returns the minimum interval required between calls to Shaking(), in milliseconds. Once the phone starts being shaken, all further Shaking() calls will be ignored until the interval has elapsed.

Returns
minimum interval in ms

Definition at line 172 of file AccelerometerSensor.java.

◆ MinimumInterval() [2/2]

void com.google.appinventor.components.runtime.AccelerometerSensor.MinimumInterval ( int  interval)

Specifies the minimum interval required between back-to-back Shaking() events, in milliseconds. Once the phone starts being shaken, all further Shaking() events will be ignored until the interval has elapsed.

Parameters
intervalminimum interval in ms

Definition at line 186 of file AccelerometerSensor.java.

◆ onAccuracyChanged()

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

Definition at line 475 of file AccelerometerSensor.java.

◆ onDelete()

void com.google.appinventor.components.runtime.AccelerometerSensor.onDelete ( )

◆ onPause()

void com.google.appinventor.components.runtime.AccelerometerSensor.onPause ( )

◆ onResume()

void com.google.appinventor.components.runtime.AccelerometerSensor.onResume ( )

◆ onSensorChanged()

void com.google.appinventor.components.runtime.AccelerometerSensor.onSensorChanged ( SensorEvent  sensorEvent)

Definition at line 455 of file AccelerometerSensor.java.

◆ Sensitivity() [1/2]

int com.google.appinventor.components.runtime.AccelerometerSensor.Sensitivity ( )

Returns a number that encodes how sensitive the AccelerometerSensor is. The choices are: 1 = weak, 2 = moderate, 3 = strong.

Returns
one of Component#ACCELEROMETER_SENSITIVITY_WEAK, Component#ACCELEROMETER_SENSITIVITY_MODERATE or Component#ACCELEROMETER_SENSITIVITY_STRONG

Definition at line 203 of file AccelerometerSensor.java.

◆ Sensitivity() [2/2]

void com.google.appinventor.components.runtime.AccelerometerSensor.Sensitivity ( int  sensitivity)

Specifies the sensitivity of the accelerometer. Valid values are: 1 (weak), 2 (moderate), and 3 (strong).

Parameters
sensitivityone of Component#ACCELEROMETER_SENSITIVITY_WEAK, Component#ACCELEROMETER_SENSITIVITY_MODERATE or Component#ACCELEROMETER_SENSITIVITY_STRONG

Definition at line 219 of file AccelerometerSensor.java.

◆ Shaking()

void com.google.appinventor.components.runtime.AccelerometerSensor.Shaking ( )

Indicates the device started being shaken or continues to be shaken.

Definition at line 282 of file AccelerometerSensor.java.

◆ XAccel()

float com.google.appinventor.components.runtime.AccelerometerSensor.XAccel ( )

Returns the acceleration in the X-dimension in SI units (m/s²). The sensor must be enabled to return meaningful values.

Returns
X acceleration

Definition at line 367 of file AccelerometerSensor.java.

◆ YAccel()

float com.google.appinventor.components.runtime.AccelerometerSensor.YAccel ( )

Returns the acceleration in the Y-dimension in SI units (m/s²). The sensor must be enabled to return meaningful values.

Returns
Y acceleration

Definition at line 379 of file AccelerometerSensor.java.

◆ ZAccel()

float com.google.appinventor.components.runtime.AccelerometerSensor.ZAccel ( )

Returns the acceleration in the Z-dimension in SI units (m/s²). The sensor must be enabled to return meaningful values.

Returns
Z acceleration

Definition at line 391 of file AccelerometerSensor.java.


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