PanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public class PanelEntity extends BaseEntity

java.lang.Object
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.BaseEntity
		↳	androidx.xr.scenecore.PanelEntity

Known direct subclasses

ActivityPanelEntity, MainPanelEntity

`ActivityPanelEntity`	ActivityPanelEntity creates a spatial panel for embedding an `Activity` in Android XR.
`MainPanelEntity`	Represents the main spatialized panel in a `Scene`.

PanelEntity contains an arbitrary 2D Android View, within a spatialized XR scene.

Summary

Public methods
`static final @NonNull PanelEntity`	`create( @NonNull Session session, @NonNull View view, @NonNull FloatSize2d dimensions, @NonNull String name, @NonNull Pose pose )` Factory method for a spatialized PanelEntity.
`static final @NonNull PanelEntity`	`create( @NonNull Session session, @NonNull View view, @NonNull IntSize2d pixelDimensions, @NonNull String name, @NonNull Pose pose )` Factory method for a spatialized PanelEntity.
`final float`	`getCornerRadius()` The corner radius of the PanelEntity, in meters.
`final @NonNull PerceivedResolutionResult`	`getPerceivedResolution()` Gets the perceived resolution of this Entity in the `CameraView`.
`final @NonNull FloatSize2d`	`getSize()` The dimensions of this PanelEntity in local space, in units relative to the scale of this Entity's parent.
`final @NonNull IntSize2d`	`getSizeInPixels()` The dimensions of this PanelEntity, in pixels, which is the resolution of the underlying surface.
`final boolean`	`isMainPanelEntity()` True if this panel is the MainPanelEntity, false otherwise.
`final void`	`setCornerRadius(float cornerRadius)` The corner radius of the PanelEntity, in meters.
`final void`	`setSize(@NonNull FloatSize2d size)` The dimensions of this PanelEntity in local space, in units relative to the scale of this Entity's parent.
`final void`	`setSizeInPixels(@NonNull IntSize2d sizeInPixels)` The dimensions of this PanelEntity, in pixels, which is the resolution of the underlying surface.

Inherited methods

From androidx.xr.scenecore.BaseEntity

`void`	`addChild(@NonNull Entity child)` Sets an Entity to be a child of this Entity in the scene graph.
`boolean`	`addComponent(@NonNull Component component)` Adds a Component to this Entity.
`void`	`dispose()` Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
`float`	`getAlpha(@NonNull Space relativeTo)` Returns the alpha transparency set for this Entity, relative to given Space.
`@NonNull List<@NonNull Entity>`	`getChildren()` Provides the list of all children of this entity.
`@NonNull List<@NonNull Component>`	`getComponents()` Retrieves all components attached to this Entity.
`@NonNull List<@NonNull T>`	`<T extends Component> getComponentsOfType(@NonNull Class<@NonNull T> type)` Retrieves all Components of the given type `T` and its sub-types attached to this Entity.
`@NonNull CharSequence`	`getContentDescription()` Alternate text for this Entity to be consumed by Accessibility systems.
`Entity`	`getParent()` The parent of this Entity, from which this Entity will inherit most of its properties.
`@NonNull Pose`	`getPose(@NonNull Space relativeTo)` Returns the `Pose` for this Entity, relative to the provided `Space`.
`float`	`getScale(@NonNull Space relativeTo)` Returns the scale of this entity, relative to given space.
`boolean`	`isEnabled(boolean includeParents)` Returns the enabled status of this Entity.
`void`	`removeAllComponents()` Remove all components from this Entity.
`void`	`removeComponent(@NonNull Component component)` Removes the given Component from this Entity.
`void`	`setAlpha(float alpha, @NonNull Space relativeTo)` Sets the alpha transparency of the Entity relative to given Space.
`void`	`setContentDescription(@NonNull CharSequence contentDescription)` Alternate text for this Entity to be consumed by Accessibility systems.
`void`	`setEnabled(boolean enabled)` Sets the local enabled state of this Entity.
`void`	`setParent(Entity parent)` The parent of this Entity, from which this Entity will inherit most of its properties.
`void`	`setPose(@NonNull Pose pose, @NonNull Space relativeTo)` Sets the `Pose` for this Entity.
`void`	`setScale(float scale, @NonNull Space relativeTo)` Sets the scale of this Entity relative to the given Space.

From androidx.xr.scenecore.Entity

`@FloatRange(from = 0.0, to = 1.0) float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`@NonNull Pose`	`getPose()` Returns the `Pose` for this Entity, relative to its parent.
`@FloatRange(from = 0.0) float`	`getScale()` Returns the local scale of this Entity, not inclusive of the parent's scale.
`void`	`setAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha)` Sets the alpha transparency of the Entity and its children.
`void`	`setPose(@NonNull Pose pose)` Sets the `Pose` for this Entity, relative to its parent.
`void`	`setScale(@FloatRange(from = 0.0) float scale)` Sets the scale of this Entity relative to its parent.

From androidx.xr.scenecore.ScenePose

`abstract @NonNull Pose`	`getActivitySpacePose()` The current `Pose` relative to the activity space root.
`abstract HitTestResult`	`hitTest(@NonNull Vector3 origin, @NonNull Vector3 direction)` Perform a hit test from the specified origin in the specified direction into the Scene.
`abstract HitTestResult`	`hitTest( @NonNull Vector3 origin, @NonNull Vector3 direction, int hitTestFilter )` Creates a hit test from the specified origin in the specified direction into the scene.
`abstract @NonNull Pose`	`transformPoseTo(@NonNull Pose pose, @NonNull ScenePose destination)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.

Public methods

create

Added in 1.0.0-alpha09

public static final @NonNull PanelEntity create(
    @NonNull Session session,
    @NonNull View view,
    @NonNull FloatSize2d dimensions,
    @NonNull String name,
    @NonNull Pose pose
)

Factory method for a spatialized PanelEntity.

Parameters
`@NonNull Session session`	XR `Session` in which to create the PanelEntity.
`@NonNull View view`	`View` to embed in this panel entity.
`@NonNull FloatSize2d dimensions`	Spatialized dimensions for the underlying surface for the given view, in meters.
`@NonNull String name`	Name of this PanelEntity.
`@NonNull Pose pose`	`Pose` of this entity relative to its parent, default value is Identity.

Returns
`@NonNull PanelEntity`	a PanelEntity instance.

create

Added in 1.0.0-alpha09

public static final @NonNull PanelEntity create(
    @NonNull Session session,
    @NonNull View view,
    @NonNull IntSize2d pixelDimensions,
    @NonNull String name,
    @NonNull Pose pose
)

Factory method for a spatialized PanelEntity.

Parameters
`@NonNull Session session`	XR `Session` in which to create the PanelEntity.
`@NonNull View view`	`View` to embed in this panel entity.
`@NonNull IntSize2d pixelDimensions`	Dimensions for the underlying surface for the given view, in pixels.
`@NonNull String name`	Name of the panel.
`@NonNull Pose pose`	`Pose` of this PanelEntity relative to its parent, default value is Identity.

Returns
`@NonNull PanelEntity`	a PanelEntity instance.

getCornerRadius

Added in 1.0.0-alpha09

public final float getCornerRadius()

The corner radius of the PanelEntity, in meters.

getPerceivedResolution

Added in 1.0.0-alpha09

public final @NonNull PerceivedResolutionResult getPerceivedResolution()

Gets the perceived resolution of this Entity in the CameraView.

This API is only intended for use in Full Space Mode and will return PerceivedResolutionResult.InvalidCameraView in Home Space Mode. For applications requiring perceived resolution in Home Space Mode, see MainPanelEntity.getPerceivedResolution.

This value represents the dimensions of the Entity on the camera view if its largest surface was facing the camera without changing the distance of the Entity to the camera. This can be used by clients to dynamically optimize the resolution of assets within the PanelEntity, for example by using lower-resolution assets within panels that are further from the viewer. The Entity's own rotation and the camera's viewing direction are disregarded.

Returns
`@NonNull PerceivedResolutionResult`	A `PerceivedResolutionResult` which encapsulates the outcome: - `PerceivedResolutionResult.Success` containing the PixelDimensions if the calculation is successful. - `PerceivedResolutionResult.EntityTooClose` if the Entity is too close to the camera. - `PerceivedResolutionResult.InvalidCameraView` if the camera information required for the calculation is invalid or unavailable.

Throws
`kotlin.IllegalStateException`	if Session.config.deviceTracking is not set to `Config.DeviceTrackingMode.LAST_KNOWN`.

See also
`PerceivedResolutionResult`

getSize

Added in 1.0.0-alpha09

public final @NonNull FloatSize2d getSize()

The dimensions of this PanelEntity in local space, in units relative to the scale of this Entity's parent.

getSizeInPixels

Added in 1.0.0-alpha09

public final @NonNull IntSize2d getSizeInPixels()

The dimensions of this PanelEntity, in pixels, which is the resolution of the underlying surface.

This API doesn't do any scale compensation to the pixel dimensions.

isMainPanelEntity

Added in 1.0.0-alpha09

public final boolean isMainPanelEntity()

True if this panel is the MainPanelEntity, false otherwise.

setCornerRadius

Added in 1.0.0-alpha09

public final void setCornerRadius(float cornerRadius)

The corner radius of the PanelEntity, in meters.

setSize

Added in 1.0.0-alpha09

public final void setSize(@NonNull FloatSize2d size)

The dimensions of this PanelEntity in local space, in units relative to the scale of this Entity's parent.

setSizeInPixels

Added in 1.0.0-alpha09

public final void setSizeInPixels(@NonNull IntSize2d sizeInPixels)

The dimensions of this PanelEntity, in pixels, which is the resolution of the underlying surface.

This API doesn't do any scale compensation to the pixel dimensions.