public class PanelEntity extends BasePanelEntity

java.lang.Object
   ↳ androidx.xr.scenecore.BaseActivityPose
     ↳ androidx.xr.scenecore.BaseEntity
       ↳ androidx.xr.scenecore.BasePanelEntity
         ↳ androidx.xr.scenecore.PanelEntity
Known direct subclasses
ActivityPanelEntity

ActivityPanelEntity creates a spatial panel for embedding an Activity in Android XR.

PanelEntity creates a spatial panel in Android XR.

Summary

Public methods
static final @NonNull PanelEntity
create(
    @NonNull Session session,
    @NonNull View view,
    @NonNull Dimensions dimensions,
    @NonNull String name,
    @NonNull Pose pose
)

Public factory function for a spatialized PanelEntity.
static final @NonNull PanelEntity
create(
    @NonNull Session session,
    @NonNull View view,
    @NonNull PixelDimensions pixelDimensions,
    @NonNull String name,
    @NonNull Pose pose
)

Public factory function for a spatialized PanelEntity.
final boolean

Inherited methods
From androidx.xr.scenecore.ActivityPose
abstract @NonNull Pose

Returns the activity space pose for this ActivityPose.
abstract @NonNull ListenableFuture<@NonNull HitTestResult>
hitTestAsync(@NonNull Vector3 origin, @NonNull Vector3 direction)

Creates a hit test from the specified origin in the specified direction into the scene.
abstract @NonNull ListenableFuture<@NonNull HitTestResult>
hitTestAsync(
    @NonNull Vector3 origin,
    @NonNull Vector3 direction,
    @ActivityPose.HitTestFilterValue int hitTestFilter
)

Creates a hit test from the specified origin in the specified direction into the scene.
abstract @NonNull Pose

Returns a pose relative to this ActivityPose transformed into a pose relative to the destination.
From androidx.xr.scenecore.BaseEntity
void

Sets an Entity to be represented in this coordinate space.
boolean

Adds a Component to this Entity.
void

Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
float
getAlpha(int relativeTo)

Returns the alpha transparency set for this Entity, relative to given space.
@NonNull List<@NonNull Component>

Retrieves all components attached to this Entity.
@NonNull List<@NonNull T>

Retrieves all Components of the given type T and its sub-types attached to this Entity.
Entity

Returns the parent of this Entity.
@NonNull Pose
getPose(int relativeTo)

Returns the pose for this entity, relative to the provided space.
float
getScale(int relativeTo)

Returns the scale of this entity, relative to given space.
boolean
isHidden(boolean includeParents)

Returns the hidden status of this Entity.
void

Remove all components from this Entity.
void

Removes the given Component from this Entity.
void
setAlpha(float alpha, int relativeTo)

Sets the alpha transparency of the Entity relative to given space.
void

Sets alternate text for this entity to be consumed by Accessibility systems.
void
setHidden(boolean hidden)

Sets the local hidden state of this Entity.
void
setParent(Entity parent)

Sets this Entity to be represented in the parent's coordinate space.
void
setPose(@NonNull Pose pose, int relativeTo)

Sets the pose for this Entity.
void
setScale(float scale, int relativeTo)

Sets the scale of this entity relative to given space.
From androidx.xr.scenecore.BasePanelEntity
final float

Gets the corner radius of this PanelEntity in meters.
final @NonNull Vector3

This method is deprecated. This api will be removed in a future release.
final @NonNull Dimensions

Returns the dimensions in local space, in unscaled meters for this panel entity.
final @NonNull PixelDimensions

Returns the dimensions in Pixels for this panel entity.
final void
setCornerRadius(float radius)

Sets the corner radius of the PanelEntity.
final void
setSize(@NonNull Dimensions dimensions)

Sets the size in meters for the surface on which the View is laid out.
final void

Sets the size in pixels for the surface on which the view is laid out.
From androidx.xr.scenecore.Entity
float

Returns the alpha transparency set for this Entity.
@NonNull Pose

Returns the pose for this entity, relative to its parent.
float

Returns the local scale of this entity, not inclusive of the parent's scale.
void
setAlpha(float alpha)

Sets the alpha transparency of the Entity and its children.
void

Sets the pose for this Entity, relative to its parent.
void
setScale(float scale)

Sets the scale of this entity relative to its parent.

Public methods

create

Added in 1.0.0-alpha04
public static final @NonNull PanelEntity create(
    @NonNull Session session,
    @NonNull View view,
    @NonNull Dimensions dimensions,
    @NonNull String name,
    @NonNull Pose pose
)

Public factory function for a spatialized PanelEntity.

Parameters
@NonNull Session session

Session to create the PanelEntity in.
@NonNull View view

View to embed in this panel entity.
@NonNull Dimensions dimensions

Dimensions for the underlying surface for the given view in meters.
@NonNull String name

Name of the panel.
@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-alpha04
public static final @NonNull PanelEntity create(
    @NonNull Session session,
    @NonNull View view,
    @NonNull PixelDimensions pixelDimensions,
    @NonNull String name,
    @NonNull Pose pose
)

Public factory function for a spatialized PanelEntity.

Parameters
@NonNull Session session

Session to create the PanelEntity in.
@NonNull View view

View to embed in this panel entity.
@NonNull PixelDimensions 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 entity relative to its parent, default value is Identity.
Returns
@NonNull PanelEntity

a PanelEntity instance.

isMainPanelEntity

Added in 1.0.0-alpha04
public final boolean isMainPanelEntity()