ActivityPanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

class ActivityPanelEntity : PanelEntity

kotlin.Any
↳	androidx.xr.scenecore.BaseScenePose
	↳	androidx.xr.scenecore.BaseEntity
		↳	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.SPATIAL_CAPABILITY_EMBED_ACTIVITY capability is required. Calling Entity.dispose on this Entity will destroy the underlying Activity.

Summary

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

Public functions
`Unit`	`startActivity(intent: Intent)` Starts an `Activity` in the given panel.
`Unit`	`transferActivity(activity: Activity)` Transfers the given `Activity` into this panel.

Inherited functions

From androidx.xr.scenecore.BaseEntity

`open Unit`	`addChild(child: Entity)` Sets an Entity to be a child of this Entity in the scene graph.
`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: Space)` 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 Pose`	`getPose(relativeTo: Space)` Returns the `Pose` for this Entity, relative to the provided `Space`.
`open Float`	`getScale(relativeTo: Space)` Returns the scale of this entity, relative to given space.
`open Boolean`	`isEnabled(includeParents: Boolean)` Returns the enabled 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: Space)` Sets the alpha transparency of the Entity relative to given Space.
`open Unit`	`setEnabled(enabled: Boolean)` Sets the local enabled state of this Entity.
`open Unit`	`setPose(pose: Pose, relativeTo: Space)` Sets the `Pose` for this Entity.
`open Unit`	`setScale(scale: Float, relativeTo: Space)` Sets the scale of this Entity relative to the given Space.

From androidx.xr.scenecore.Entity

`open @FloatRange(from = 0.0, to = 1.0) Float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`open Pose`	`getPose()` Returns the `Pose` for this Entity, relative to its parent.
`open @FloatRange(from = 0.0) Float`	`getScale()` Returns the local scale of this Entity, not inclusive of the parent's scale.
`open Unit`	`setAlpha(alpha: @FloatRange(from = 0.0, to = 1.0) 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: @FloatRange(from = 0.0) Float)` Sets the scale of this Entity relative to its parent.

From androidx.xr.scenecore.PanelEntity

PerceivedResolutionResult

getPerceivedResolution()

Gets the perceived resolution of this Entity in the CameraView.

From androidx.xr.scenecore.ScenePose

`abstract suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3)` Perform a hit test from the specified origin in the specified direction into the Scene.
`abstract suspend HitTestResult?`	`hitTest(origin: Vector3, direction: Vector3, hitTestFilter: Int)` Creates a hit test from the specified origin in the specified direction into the scene.
`abstract Pose`	`transformPoseTo(pose: Pose, destination: ScenePose)` Returns a `Pose` relative to this ScenePose, transformed into a Pose relative to the destination.

Inherited properties

From androidx.xr.scenecore.BaseEntity

`open List<Entity>`	`children` Provides the list of all children of this entity.
`open CharSequence`	`contentDescription` Alternate text for this Entity to be consumed by Accessibility systems.
`open Entity?`	`parent` The parent of this Entity, from which this Entity will inherit most of its properties.

From androidx.xr.scenecore.PanelEntity

`Float`	`cornerRadius` The corner radius of the PanelEntity, in meters.
`Boolean`	`isMainPanelEntity` True if this panel is the MainPanelEntity, false otherwise.
`FloatSize2d`	`size` The dimensions of this PanelEntity in local space, in units relative to the scale of this Entity's parent.
`IntSize2d`	`sizeInPixels` The dimensions of this PanelEntity, in pixels, which is the resolution of the underlying surface.

From androidx.xr.scenecore.ScenePose

abstract Pose

activitySpacePose

The current Pose relative to the activity space root.

Public companion functions

create

Added in 1.0.0-alpha09

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

Public factory function for a spatial ActivityPanelEntity.

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

Returns
`ActivityPanelEntity`	an ActivityPanelEntity instance.

Public functions

startActivity

Added in 1.0.0-alpha09

fun startActivity(intent: Intent): Unit

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.SPATIAL_CAPABILITY_EMBED_ACTIVITY capability. This method will not provide any information about when the Activity successfully launches.

Parameters
`intent: Intent`	Intent to launch the activity.

transferActivity

Added in 1.0.0-alpha09

fun transferActivity(activity: Activity): Unit

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

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