ActivityPanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class ActivityPanelEntity extends PanelEntity

java.lang.Object
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.Entity
		↳	androidx.xr.scenecore.PanelEntity
			↳	androidx.xr.scenecore.ActivityPanelEntity

ActivityPanelEntity creates a spatial panel for embedding an Activity in Android XR. Users can either use an Intent to launch an Activity in the given panel or provide an instance of Activity to move into this panel. In order to launch and embed an activity, SpatialCapability.EMBED_ACTIVITY capability is required. When this Entity is destroyed it will destroy the underlying Activity.

Summary

Public methods
`static final @NonNull ActivityPanelEntity`	`create( @NonNull Session session, @NonNull IntSize2d pixelDimensions, @NonNull String name, @NonNull Pose pose, Entity parent )` Public factory function for a spatial ActivityPanelEntity.
`final void`	`startActivity(@NonNull Intent intent)` Starts an `Activity` in the given panel.
`final void`	`transferActivity(@NonNull Activity activity)` Transfers the given `Activity` into this panel.

Inherited methods

From androidx.xr.scenecore.BaseScenePose

`@NonNull Pose`	`getPoseInActivitySpace()` The current `Pose` relative to the activity space root.
`HitTestResult`	`hitTest(@NonNull Vector3 origin, @NonNull Vector3 direction)` Perform a hit test from the specified origin in the specified direction into the Scene.
`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.
`@NonNull Vector3`	`transformDirectionTo( @NonNull Vector3 direction, @NonNull ScenePose destination )` Transforms a direction from this ScenePose's local space to the destination ScenePose's local space.
`@NonNull Pose`	`transformPoseTo(@NonNull Pose pose, @NonNull ScenePose destination)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.
`@NonNull Vector3`	`transformPositionTo( @NonNull Vector3 position, @NonNull ScenePose destination )` Transforms a position from this ScenePose's local space to the destination ScenePose's local space.
`@NonNull Vector3`	`transformVectorTo(@NonNull Vector3 vector, @NonNull ScenePose destination)` Transforms a vector from this ScenePose's local space to the destination ScenePose's local space.

From androidx.xr.scenecore.Entity

`final void`	`addChild(@NonNull Entity child)` Sets an Entity to be a child of this Entity in the scene graph.
`final boolean`	`addComponent(@NonNull Component component)` Adds a Component to this Entity.
`final @FloatRange(from = 0.0, to = 1.0) float`	`getAlpha(@NonNull Space relativeTo)` Returns the alpha transparency set for this Entity, relative to given Space.
`final @NonNull List<@NonNull Entity>`	`getChildren()` Provides the list of all children of this entity.
`final @NonNull List<@NonNull Component>`	`getComponents()` Retrieves all components attached to this Entity.
`final @NonNull List<@NonNull T>`	`<T extends Component> getComponentsOfType(@NonNull Class<@NonNull T> type)` Retrieves all Components of the given type `T` and its subtypes attached to this Entity.
`final @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`.
`@FloatRange(from = 0.0) float`	`getScale(@NonNull Space relativeTo)` Returns the scale of this entity, relative to given space.
`final boolean`	`isEnabled(boolean includeParents)` Returns the enabled status of this Entity.
`final void`	`removeAllComponents()` Remove all components from this Entity.
`final void`	`removeComponent(@NonNull Component component)` Removes the given Component from this Entity.
`final void`	`setAlpha(@FloatRange(from = 0.0, to = 1.0) float alpha)` Sets the alpha transparency of the Entity relative to the parent Space.
`final void`	`setContentDescription(@NonNull CharSequence value)` Alternate text for this Entity to be consumed by Accessibility systems.
`final void`	`setEnabled(boolean enabled)` Sets the local enabled state of this Entity.
`void`	`setParent(Entity value)` 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(@FloatRange(from = 0.0) float scale, @NonNull Space relativeTo)` Sets the scale of this Entity relative to the given Space.

From androidx.xr.scenecore.PanelEntity

`final float`	`getCornerRadius()` The corner radius of the PanelEntity, in meters.
`final @NonNull PerceivedResolutionResult`	`getPerceivedResolution(@NonNull RenderViewpoint renderViewpoint)` Gets the perceived resolution of this Entity in the provided `RenderViewpoint`.
`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 value)` The corner radius of the PanelEntity, in meters.
`final void`	`setSize(@NonNull FloatSize2d value)` The dimensions of this PanelEntity in local space, in units relative to the scale of this Entity's parent.
`final void`	`setSizeInPixels(@NonNull IntSize2d value)` The dimensions of this PanelEntity, in pixels, which is the resolution of the underlying surface.
`final @NonNull Vector3`	`transformNormalizedCoordinatesToLocalPosition( @NonNull Vector2 coordinates )` Gets the 3D position of a 2D normalized extent coordinate within the entity's local space.
`final @NonNull Vector3`	`transformPixelCoordinatesToLocalPosition(@NonNull Vector2 coordinates)` Gets the 3D position of a 2D pixel coordinate within the entity's local space.

Public methods

create

Added in 1.0.0-beta01

public static final @NonNull ActivityPanelEntity create(
    @NonNull Session session,
    @NonNull IntSize2d pixelDimensions,
    @NonNull String name,
    @NonNull Pose pose,
    Entity parent
)

Public factory function for a spatial ActivityPanelEntity.

Parameters
`@NonNull Session session`	XR `Session` to create the ActivityPanelEntity.
`@NonNull IntSize2d pixelDimensions`	Bounds for the panel surface in pixels.
`@NonNull String name`	Name of the panel.
`@NonNull Pose pose`	`Pose` of this entity relative to its parent, the default value is `Pose.Identity`.
`Entity parent`	Parent entity. Defaults to `null`. If `null`, the entity is created but not attached to the scene graph, meaning it will be invisible. If a parent entity (e.g., `ActivitySpace` or any other `Entity` already present in the scene) is assigned later, the entity will become visible (provided it is enabled). This allows for `Entity` pre-configuration before making it visible.

Returns
`@NonNull ActivityPanelEntity`	an ActivityPanelEntity instance.

startActivity

Added in 1.0.0-beta01

public final void startActivity(@NonNull Intent intent)

Starts an Activity in the given panel. Subsequent calls to this method will replace the already existing Activity in the panel with the new one. The panel will not be visible until an Activity is successfully launched. This will fail if the Scene does not have the SpatialCapability.EMBED_ACTIVITY capability. This method will not provide any information about when the Activity successfully launches.

Parameters
`@NonNull Intent intent`	Intent to launch the activity.

transferActivity

Added in 1.0.0-beta01

public final void transferActivity(@NonNull Activity activity)

Transfers the given Activity into this panel. This will fail if the application does not have the SpatialCapability.EMBED_ACTIVITY capability.

Parameters
`@NonNull Activity activity`	Activity to move into this panel.