ActivityPanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public final class ActivityPanelEntity extends PanelEntity

java.lang.Object
↳	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 methods
`final void`	`launchActivity(@NonNull Intent intent, Bundle bundle)` Launches an activity in the given panel.
`final void`	`moveActivity(@NonNull Activity activity)` Moves the given activity into this panel.

Inherited methods

From androidx.xr.scenecore.ActivityPose

`abstract @NonNull Pose`	`getActivitySpacePose()` Returns the activity space pose for this ActivityPose.
`abstract @NonNull Pose`	`transformPoseTo(@NonNull Pose pose, @NonNull ActivityPose destination)` Returns a pose relative to this ActivityPose transformed into a pose relative to the destination.

From androidx.xr.scenecore.BaseEntity

`void`	`addChild(@NonNull Entity child)` Sets an Entity to be represented in this coordinate space.
`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`	`getActivitySpaceAlpha()` Returns the global alpha of this entity computed by multiplying the parent's global alpha to this entity's local alpha.
`float`	`getAlpha()` Returns the alpha transparency set for 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.
`Entity`	`getParent()` Returns the parent of this Entity.
`@NonNull Pose`	`getPose()` Returns the pose for this entity, relative to its parent.
`float`	`getScale()` Returns the local scale of this entity, not inclusive of the parent's scale.
`float`	`getWorldSpaceScale()` Returns the accumulated scale of this Entity.
`boolean`	`isHidden(boolean includeParents)` Returns the hidden 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)` Sets the alpha transparency of the Entity and its children.
`void`	`setContentDescription(@NonNull String text)` 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)` Sets the pose for this Entity, relative to its parent.
`void`	`setScale(float scale)` Sets the scale of this entity relative to its parent.
`void`	`setSize(@NonNull Dimensions dimensions)` Sets the dimensions in pixels for the Entity.

From androidx.xr.scenecore.BasePanelEntity

`final float`	`getCornerRadius()` Gets the corner radius of this PanelEntity in meters.
`final @NonNull Vector3`	`getPixelDensity()` Gets the number of pixels per meter for this panel.
`final @NonNull PixelDimensions`	`getPixelDimensions()` Returns the dimensions of the view underlying this PanelEntity.
`@NonNull Dimensions`	`getSize()` Returns the spatial size of this Panel in meters.
`final void`	`setCornerRadius(float radius)` Sets the corner radius of the PanelEntity.
`final void`	`setPixelDimensions(@NonNull PixelDimensions pxDimensions)` Sets the pixel (not Dp) dimensions of the view underlying this PanelEntity.

From androidx.xr.scenecore.PanelEntity

final boolean

isMainPanelEntity()

Public methods

launchActivity

Added in 1.0.0-alpha01

public final void launchActivity(@NonNull Intent intent, Bundle bundle)

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 setPixelDimensions().

Parameters
`@NonNull Intent intent`	Intent to launch the activity.
`Bundle bundle`	Bundle to pass to the activity, can be null.

moveActivity

Added in 1.0.0-alpha01

public final void moveActivity(@NonNull Activity activity)

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 setPixelDimensions().

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