ActivityPanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class ActivityPanelEntity extends PanelEntity

java.lang.Object
↳	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.EMBED_ACTIVITY capability is required. Calling Entity.dispose on this Entity 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 )` 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.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.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.
`final @NonNull Pose`	`@ExperimentalPanelCoordinateApi transformNormalizedCoordinatesToPose(@NonNull Vector2 coordinates)` Gets the 3D pose of a 2D normalized extent coordinate within the Entity's local space.
`final @NonNull Pose`	`@ExperimentalPanelCoordinateApi transformPixelCoordinatesToPose(@NonNull Vector2 coordinates)` Gets the 3D pose of a 2D pixel coordinate within the Entity's local space.

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-alpha10

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

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`.

Returns
`@NonNull ActivityPanelEntity`	an ActivityPanelEntity instance.

startActivity

Added in 1.0.0-alpha10

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-alpha10

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.