目录

ARPlane

Class Info

public class ARPlane extends ARTrackableBase

保存AR Engine识别的真实世界中的平面信息,派生自ARTrackableBase。两个或者多个平面法向量朝向一致,位置靠近时会自动合并到一个父平面中,合并之后每个子平面的getSubsumedBy()将返回父平面。被合并的子平面将继续被跟踪和返回。

Public Method Summary

Qualifier and Type

Method Name and Description

ARPose

getCenterPose()

获取从平面的局部坐标系到世界坐标系转换的pose。

  1. 平面局部坐标系(右手坐标系)为:原点在包裹平面的矩形的中心,Y+为平面法向量,X与Z与矩形边界的方向一致,矩形长方向为X轴,宽为Z轴。
  2. 如果平面因为扩展导致原来的宽长度超过了原来的长,那么XZ会互换,最终满足:矩形更长的方向为X轴。由于输出和每一帧的点云有关,若点云输出有差异,X+方向会发生变化。

float

getExtentX()

获取平面的矩形边界沿平面局部坐标系X轴的长度,如矩形的宽度。

float

getExtentZ()

获取平面的矩形边界沿平面局部坐标系Z轴的长度,如矩形的高度。

SemanticPlaneLabel

getLabel()

获取当前平面被识别为的语义类型,如桌面、地板,使用时需要使用setSemanticMode()启用语义识别模式。

FloatBuffer

getPlanePolygon()

获取检测平面的二维顶点数据,格式为[x1, z1, x2, z2, ...],这些值均在平面局部坐标系的x-z平面中定义,须经getCenterPose()转换到世界坐标系中。注意:在垂直平面中返回的值也是局部坐标系中的坐标[x1,z1,x2,z2,….],需要使用getCenterPose()转换到世界坐标系。

ARPlane

getSubsumedBy()

获取平面的父平面(一个平面被另一个平面合并时,会产生父平面),如果无父平面返回为null。

PlaneType

getType()

获取平面的类型。

boolean

isPoseInExtents(ARPose pose)

如果传入的位姿(通过ARHitResult.getHitPose()获取)位于平面的矩形范围内,则返回true。

boolean

isPoseInPolygon(ARPose pose)

如果传入的位姿(通过ARHitResult.getHitPose()获取)位于平面的多边形中,则返回true。

Public Methods

[h2]getCenterPose

Method

public ARPose getCenterPose()

获取平面的局部坐标系到世界坐标系转换的pose。

  1. 平面局部坐标系(右手坐标系)为:原点在包裹平面的矩形的中心,Y+为平面法向量,X与Z与矩形边界的方向一致,矩形长方向为X轴,宽为Z轴。
  2. 如果平面因为扩展导致原来的宽长度超过了原来的长,那么XZ会互换,最终满足:矩形更长的方向为X轴。由于输出和每一帧的点云有关,若点云输出有差异,X+方向会发生变化。

Returns

Type

Description

ARPose

平面的局部坐标系到世界坐标系转换的pose。

[h2]getExtentX

Method

public float getExtentX()

获取平面的矩形边界沿平面局部坐标系X轴的长度,如矩形的宽度。

Returns

Type

Description

float

平面的矩形边界沿平面局部坐标系X轴的长度。

[h2]getExtentZ

Method

public float getExtentZ()

获取平面的矩形边界沿平面局部坐标系Z轴的长度,如矩形的高度。

Returns

Type

Description

float

平面的矩形边界沿平面局部坐标系Z轴的长度。

[h2]getLabel

Method

public SemanticPlaneLabel getLabel()

获取当前平面被识别为的语义类型,如桌面、地板,使用时需要使用setSemanticMode()启用语义识别模式。

Returns

Type

Description

SemanticPlaneLabel

当前平面被识别为的语义类型。

[h2]getPlanePolygon

Method

public FloatBuffer getPlanePolygon()

获取检测平面的二维顶点数据,格式为[x1, z1, x2, z2, ...],这些值均在平面局部坐标系的x-z平面中定义,须经getCenterPose()转换到世界坐标系中。注意:在垂直平面中返回的值也是局部坐标系中的坐标[x1,z1,x2,z2,….],需要使用getCenterPose()转换到世界坐标系。

Returns

Type

Description

FloatBuffer

检测平面的二维顶点数组。

[h2]getSubsumedBy

Method

public ARPlane getSubsumedBy()

获取平面的父平面(一个平面被另一个平面合并时,会产生父平面),如果无父平面返回为null。

Returns

Type

Description

ARPlane

平面的父平面。

[h2]getType

Method

public PlaneType getType()

获取平面的类型。

Returns

Type

Description

PlaneType

平面的类型。

[h2]isPoseInExtents

Method

public boolean isPoseInExtents(ARPose pose)

如果传入的位姿(通过ARHitResult.getHitPose()获取)位于平面的矩形范围内,则返回true。

Parameters

Name

Description

pose

需要判断的位姿信息。

Returns

Type

Description

boolean

给定位姿是否位于平面的矩形范围内。

[h2]isPoseInPolygon

Method

public boolean isPoseInPolygon(ARPose pose)

如果传入的位姿(通过ARHitResult.getHitPose()获取)位于平面的多边形中,则返回true。

Parameters

Name

Description

pose

需要判断的位姿信息。

Returns

Type

Description

boolean

给定位姿是否位于平面的多边形中。