ActivityPanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

class ActivityPanelEntity : PanelEntity

kotlin.Any
↳	androidx.xr.scenecore.BaseActivityPose
	↳	androidx.xr.scenecore.BaseEntity
		↳	androidx.xr.scenecore.BasePanelEntity
			↳	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. Calling dispose() on this entity will destroy the underlying activity.

Summary

Public companion functions
`ActivityPanelEntity`	`create(session: Session, windowBoundsPx: Rect, name: String, pose: Pose)` Public factory function for a spatial ActivityPanelEntity.

Public functions
`Unit`	`launchActivity(intent: Intent, bundle: Bundle?)` Launches an activity in the given panel.
`Unit`	`moveActivity(activity: Activity)` Moves the given activity into this panel.

Inherited functions

From androidx.xr.scenecore.ActivityPose

`abstract Pose`	`getActivitySpacePose()` Returns the activity space pose for this ActivityPose.
`abstract ListenableFuture<HitTestResult>`	`hitTestAsync(origin: Vector3, direction: Vector3)` Creates a hit test from the specified origin in the specified direction into the scene.
`abstract ListenableFuture<HitTestResult>`	`hitTestAsync( origin: Vector3, direction: Vector3, @ActivityPose.HitTestFilterValue hitTestFilter: Int )` Creates a hit test from the specified origin in the specified direction into the scene.
`abstract Pose`	`transformPoseTo(pose: Pose, destination: ActivityPose)` Returns a pose relative to this ActivityPose transformed into a pose relative to the destination.

From androidx.xr.scenecore.BaseEntity

`open Unit`	`addChild(child: Entity)` Sets an Entity to be represented in this coordinate space.
`open Boolean`	`addComponent(component: Component)` Adds a Component to this Entity.
`open Unit`	`dispose()` Disposes of any system resources held by this Entity, and transitively calls dispose() on all its children.
`open Float`	`getAlpha(relativeTo: Int)` Returns the alpha transparency set for this Entity, relative to given space.
`open List<Component>`	`getComponents()` Retrieves all components attached to this Entity.
`open List<T>`	`<T : Component> getComponentsOfType(type: Class<T>)` Retrieves all Components of the given type `T` and its sub-types attached to this Entity.
`open Entity?`	`getParent()` Returns the parent of this Entity.
`open Pose`	`getPose(relativeTo: Int)` Returns the pose for this entity, relative to the provided space.
`open Float`	`getScale(relativeTo: Int)` Returns the scale of this entity, relative to given space.
`open Boolean`	`isHidden(includeParents: Boolean)` Returns the hidden status of this Entity.
`open Unit`	`removeAllComponents()` Remove all components from this Entity.
`open Unit`	`removeComponent(component: Component)` Removes the given Component from this Entity.
`open Unit`	`setAlpha(alpha: Float, relativeTo: Int)` Sets the alpha transparency of the Entity relative to given space.
`open Unit`	`setContentDescription(text: String)` Sets alternate text for this entity to be consumed by Accessibility systems.
`open Unit`	`setHidden(hidden: Boolean)` Sets the local hidden state of this Entity.
`open Unit`	`setParent(parent: Entity?)` Sets this Entity to be represented in the parent's coordinate space.
`open Unit`	`setPose(pose: Pose, relativeTo: Int)` Sets the pose for this Entity.
`open Unit`	`setScale(scale: Float, relativeTo: Int)` Sets the scale of this entity relative to given space.

From androidx.xr.scenecore.BasePanelEntity

`Float`	`getCornerRadius()` Gets the corner radius of this PanelEntity in meters.
`Vector3`	`getPixelDensity()` This function is deprecated. This api will be removed in a future release.
`Dimensions`	`getSize()` Returns the dimensions in local space, in unscaled meters for this panel entity.
`PixelDimensions`	`getSizeInPixels()` Returns the dimensions in Pixels for this panel entity.
`Unit`	`setCornerRadius(radius: Float)` Sets the corner radius of the PanelEntity.
`Unit`	`setSize(dimensions: Dimensions)` Sets the size in meters for the surface on which the View is laid out.
`Unit`	`setSizeInPixels(pixelDimensions: PixelDimensions)` Sets the size in pixels for the surface on which the view is laid out.

From androidx.xr.scenecore.Entity

`open Float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`open Pose`	`getPose()` Returns the pose for this entity, relative to its parent.
`open Float`	`getScale()` Returns the local scale of this entity, not inclusive of the parent's scale.
`open Unit`	`setAlpha(alpha: Float)` Sets the alpha transparency of the Entity and its children.
`open Unit`	`setPose(pose: Pose)` Sets the pose for this Entity, relative to its parent.
`open Unit`	`setScale(scale: Float)` Sets the scale of this entity relative to its parent.

Inherited properties

From androidx.xr.scenecore.PanelEntity

Boolean

isMainPanelEntity

Public companion functions

create

Added in 1.0.0-alpha04

fun create(
    session: Session,
    windowBoundsPx: Rect,
    name: String,
    pose: Pose = Pose.Identity
): ActivityPanelEntity

Public factory function for a spatial ActivityPanelEntity.

Parameters
`session: Session`	Session to create the ActivityPanelEntity in.
`windowBoundsPx: Rect`	Bounds for the panel window in pixels.
`name: String`	Name of the panel.
`pose: Pose = Pose.Identity`	Pose of this entity relative to its parent, default value is Identity.

Returns
`ActivityPanelEntity`	an ActivityPanelEntity instance.

Public functions

launchActivity

Added in 1.0.0-alpha04

fun launchActivity(intent: Intent, bundle: Bundle? = null): Unit

Launches an activity in the given panel. Subsequent calls to this method will replace the already existing activity in the panel with the new one. If the intent fails to launch the activity, the panel will not be visible. Note this will not update the dimensions of the surface underlying the panel. The Activity will be letterboxed as required to fit the size of the panel. The underlying surface can be resized by calling setSizeInPixels().

Parameters
`intent: Intent`	Intent to launch the activity.
`bundle: Bundle? = null`	Bundle to pass to the activity, can be null.

moveActivity

Added in 1.0.0-alpha04

fun moveActivity(activity: Activity): Unit

Moves the given activity into this panel. Note this will not update the dimensions of the surface underlying the panel. The Activity will be letterboxed as required to fit the size of the panel. The underlying surface can be resized by calling setSizeInPixels().

Parameters
`activity: Activity`	Activity to move into this panel.