orientation

Orientation模块管理设备的方向信息，包括alpha、beta、gamma三个方向信息，通过plus.orientation可获取设备方向管理对象。

方法：

对象：

回调方法：

权限：

permissions


"Orientation": {
	"description": "访问方向感应器信息"
}

getCurrentOrientation

获取当前设备的方向信息，包括alpha、beta、gamma三个方向信息


void plus.orientation.getCurrentOrientation( successCB, errorCB );

说明：

方向信息是设备相对于水平初始方向分别以z、x、y轴为轴心旋转的角度，对应值为alpha、beta、gamma三个方向的信息。 方向信息可通过successCB回调函数返回。方向信息获取失败则调用回调函数errorCB

参数：

返回值：

void : 无

平台支持：

示例：


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Orientation Example</title>
	<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数 
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕，现在可以正常调用扩展API
function onPlusReady() {
	plus.orientation.getCurrentOrientation( function ( o ) {
		alert( "Orientation\nAlpha:" + o.alpha + "\nBeta:" + o.beta + "\nGamma:" + o.gamma );
	} ); 
}
	</script>
	</head>
	<body>
		Orientation
	</body>
</html>

watchOrientation

监听设备方向信息的变化


Number plus.orientation.watchOrientation( successCB, errorCB, option );

说明：

方向信息是设备相对于水平初始方向分别以z、x、y轴为轴心旋转的角度，对应值为alpha、beta、gamma三个方向的信息。watchOrientation每隔固定时间就获取一次设备的方向信息，通过successCB回调函数返回。可通过option的frequency参数设定获取设备方向信息的时间间隔。方向信息获取失败则调用回调函数errorCB。

参数：

返回值：

Number : 用于标识方向信息监听器，可通过clearWatch方法取消监听。

平台支持：

示例：


<!DOCTYPE html>
<html>
	<head>
	<meta charset="utf-8">
	<title>Orientation Example</title>
	<script type="text/javascript">
// 扩展API加载完毕后调用onPlusReady回调函数 
document.addEventListener( "plusready", onPlusReady, false );
// 扩展API加载完毕，现在可以正常调用扩展API
function onPlusReady() {
	plus.orientation.watchOrientation( function ( o ) {
		alert( "Orientation\nAlpha:" + o.alpha + "\nBeta:" + o.beta + "\nGamma:" + o.gamma );
	}, function ( e ) {
		alert( "Orientation error: " + e.message ); 
	} ); 
}
	</script>
	</head>
	<body>
		Orientation watch
	</body>
</html>

clearWatch

关闭监听设备方向信息


void plus.orientation.clearWatch( watchId );

参数：

返回值：

void : 无

平台支持：

OrientationOption

JSON对象，监听设备方向感应器参数

属性：

Rotation

JSON对象，设备方向信息数据


interface Rotation {
	readonly attribute float alpha;
	readonly attribute float beta;
	readonly attribute float gamma;
	readonly attribute float magneticHeading;
	readonly attribute float trueHeading;
	readonly attribute float headingAccuracy;
}

属性：

OrientationSuccessCallback

获取设备方向信息成功的回调函数


void onSuccess( rotation ){
	// Get orientation success code.
}

参数：

返回值：

void : 无

OrientationErrorCallback

获取设备方向信息失败的回调函数


void onError( error ) {
	// Get orientation error code. 
}

参数：

返回值：

void : 无