# TestPlane

Artifact: [androidx.xr.arcore:arcore-testing](https://developer.android.com/jetpack/androidx/releases/xr-arcore) [View Source](https://cs.android.com/search?q=file:androidx/xr/arcore/testing/TestPlane.kt+class:androidx.xr.arcore.testing.TestPlane) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

*** ** * ** ***


```
public final class TestPlane extends TestTrackable
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.xr.arcore.testing.TestTrackable](https://developer.android.com/reference/androidx/xr/arcore/testing/TestTrackable) ||
|   | ↳ | [androidx.xr.arcore.testing.TestPlane](https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane) |

*** ** * ** ***

Flat surface in the test environment.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#TestPlane(androidx.xr.arcore.PlaneType,androidx.xr.arcore.PlaneLabel)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/PlaneType planeType, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/PlaneLabel planeLabel)` |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/math/Pose` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#getCenterPose()()` the `https://developer.android.com/reference/androidx/xr/runtime/math/Pose` at the center of the plane |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/math/FloatSize2d` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#getExtents()()` a pair of extents describing the size of the plane |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/PlaneLabel` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#getLabel()()` the `https://developer.android.com/reference/androidx/xr/arcore/PlaneLabel` that describes the surface |
| `final https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#getSubsumedBy()()` a possible other plane that this plane has been merged into |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/PlaneType` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#getType()()` the `https://developer.android.com/reference/androidx/xr/arcore/PlaneType` of the surface |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/math/Vector2>` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#getVertices()()` the `https://developer.android.com/reference/androidx/xr/runtime/math/Vector2` vertices of a convex polygon approximating the detected plane |
| `boolean` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#isVisible()()` indicates whether the trackable object is currently in view of the runtime |
| `final void` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#setCenterPose(androidx.xr.runtime.math.Pose)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/math/Pose value)` the `https://developer.android.com/reference/androidx/xr/runtime/math/Pose` at the center of the plane |
| `final void` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#setExtents(androidx.xr.runtime.math.FloatSize2d)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/math/FloatSize2d value)` a pair of extents describing the size of the plane |
| `final void` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#setLabel(androidx.xr.arcore.PlaneLabel)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/PlaneLabel value)` the `https://developer.android.com/reference/androidx/xr/arcore/PlaneLabel` that describes the surface |
| `final void` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#setSubsumedBy(androidx.xr.arcore.testing.TestPlane)(https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane value)` a possible other plane that this plane has been merged into |
| `final void` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#setType(androidx.xr.arcore.PlaneType)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/arcore/PlaneType value)` the `https://developer.android.com/reference/androidx/xr/arcore/PlaneType` of the surface |
| `final void` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#setVertices(kotlin.collections.List)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/List.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/xr/runtime/math/Vector2> value)` the `https://developer.android.com/reference/androidx/xr/runtime/math/Vector2` vertices of a convex polygon approximating the detected plane |
| `void` | `https://developer.android.com/reference/androidx/xr/arcore/testing/TestPlane#setVisible(kotlin.Boolean)(boolean value)` indicates whether the trackable object is currently in view of the runtime |

## Public constructors

### TestPlane

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public TestPlane(@NonNull PlaneType planeType, @NonNull PlaneLabel planeLabel)
```

## Public methods

### getCenterPose

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final @NonNull Pose getCenterPose()
```

the `https://developer.android.com/reference/androidx/xr/runtime/math/Pose` at the center of the plane

### getExtents

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final @NonNull FloatSize2d getExtents()
```

a pair of extents describing the size of the plane

### getLabel

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final @NonNull PlaneLabel getLabel()
```

the `https://developer.android.com/reference/androidx/xr/arcore/PlaneLabel` that describes the surface

### getSubsumedBy

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final TestPlane getSubsumedBy()
```

a possible other plane that this plane has been merged into

### getType

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final @NonNull PlaneType getType()
```

the `https://developer.android.com/reference/androidx/xr/arcore/PlaneType` of the surface

### getVertices

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final @NonNull List<@NonNull Vector2> getVertices()
```

the `https://developer.android.com/reference/androidx/xr/runtime/math/Vector2` vertices of a convex polygon approximating the detected plane

### isVisible

```
public boolean isVisible()
```

indicates whether the trackable object is currently in view of the runtime

### setCenterPose

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final void setCenterPose(@NonNull Pose value)
```

the `https://developer.android.com/reference/androidx/xr/runtime/math/Pose` at the center of the plane

### setExtents

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final void setExtents(@NonNull FloatSize2d value)
```

a pair of extents describing the size of the plane

### setLabel

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final void setLabel(@NonNull PlaneLabel value)
```

the `https://developer.android.com/reference/androidx/xr/arcore/PlaneLabel` that describes the surface

### setSubsumedBy

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final void setSubsumedBy(TestPlane value)
```

a possible other plane that this plane has been merged into

### setType

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final void setType(@NonNull PlaneType value)
```

the `https://developer.android.com/reference/androidx/xr/arcore/PlaneType` of the surface

### setVertices

Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/xr-arcore#1.0.0)

```
public final void setVertices(@NonNull List<@NonNull Vector2> value)
```

the `https://developer.android.com/reference/androidx/xr/runtime/math/Vector2` vertices of a convex polygon approximating the detected plane

### setVisible

```
public void setVisible(boolean value)
```

indicates whether the trackable object is currently in view of the runtime