AVEVA™ XR Studio

ARCorePlaneTracker

Save PDF

ARCorePlaneTracker

Save PDF

Last UpdatedDec 07, 2023
3 minute read

The ARCorePlaneTracker node determines the vertical and horizontal planes in the real world. ARCorePlaneTracker keeps detecting new planes and updating meta data of all detected planes as user moves the device in real world. The plane data can be used to render a mesh on a detected plane by overriding mesh matrix with plane matrix.

The ARCorePlaneTracker node needs ARCoreManager node to have active ARSession to track planes.

Platform support

This node is supported on Android only. Since this node is based on Android ARCore SDK, devices that support ARCore by Google Play Store or by separate downloadable Google Play Services for AR (Android China devices) support this node also.

XR-WIN	XR-P-WIN	XR-P-IOS	XR-P-AND	XR-P-WASM
No support	No support	No support	Full support	No support

Code example

This is a code example for the ARCorePlaneTracker node.

Fields

These are the fields for the ARCorePlaneTracker node. Only the node-specific fields are indicated, not fields obtained by inheritance.

Field inheritance: NodeBase > ARCorePlaneTracker

Fields	Type	Use	Default	Description
active	sbool	Optional	false	If active, plane tracker becomes ready to update detected plane data. If not active, no plane tracking and updating of plane data.
isPlaneDetected	sbool	Read only	Internally calculated	If it is false, then no plane detected yet.
planesData	mdstring	Read only	Internally Calculated	The planesData field has a plane anchor id as key. The value associated to each anchor id of plane is {matrix, center, extents, alignment}. Matrix is the transform of plane in the real world. Center is 3D center position of the plane in the real world. Extents are the lengths of the plane's bounding rectangle measured along the local X-axis and Z-axis of the coordinate space centered on the plane. Alignment is the type of plane, either horizontal or vertical.
trackMode	senum	Optional	horizontal	The trackMode specifies the type of plane to be detected. The value of trackMode can be horizontal, vertical, or both. If trackMode is set to both, then it detects both vertical and horizontal, whichever it finds.

AVEVA™ XR Studio