BasePanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

sealed class BasePanelEntity<RtPanelEntityType : JxrPlatformAdapter.PanelEntity> : BaseEntity

kotlin.Any
↳	androidx.xr.scenecore.BaseActivityPose
	↳	androidx.xr.scenecore.BaseEntity
		↳	androidx.xr.scenecore.BasePanelEntity

Known direct subclasses

PanelEntity

PanelEntity

PanelEntity creates a spatial panel in Android XR.

Known indirect subclasses

ActivityPanelEntity

ActivityPanelEntity

ActivityPanelEntity creates a spatial panel for embedding an Activity in Android XR.

Provides implementations for common Panel functionality.

Summary

Protected constructors
`<RtPanelEntityType : JxrPlatformAdapter.PanelEntity> BasePanelEntity( rtPanelEntity: RtPanelEntityType, entityManager: EntityManager )`

Public functions
`Float`	`getCornerRadius()` Gets the corner radius of this PanelEntity in meters.
`Vector3`	`getPixelDensity()` Gets the number of pixels per meter for this panel.
`PixelDimensions`	`getPixelDimensions()` Returns the dimensions of the view underlying this PanelEntity.
`open Dimensions`	`getSize()` Returns the spatial size of this Panel in meters.
`Unit`	`setCornerRadius(radius: Float)` Sets the corner radius of the PanelEntity.
`Unit`	`setPixelDimensions(pxDimensions: PixelDimensions)` Sets the pixel (not Dp) dimensions of the view underlying this PanelEntity.

Inherited functions

From androidx.xr.scenecore.ActivityPose

`abstract Pose`	`getActivitySpacePose()` Returns the activity space pose for this ActivityPose.
`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`	`getActivitySpaceAlpha()` Returns the global alpha of this entity computed by multiplying the parent's global alpha to this entity's local alpha.
`open Float`	`getAlpha()` Returns the alpha transparency set for this Entity.
`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()` 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 Float`	`getWorldSpaceScale()` Returns the accumulated scale of this Entity.
`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)` Sets the alpha transparency of the Entity and its children.
`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)` 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.
`open Unit`	`setSize(dimensions: Dimensions)` Sets the dimensions in pixels for the Entity.

Protected constructors

BasePanelEntity

protected <RtPanelEntityType : JxrPlatformAdapter.PanelEntity> BasePanelEntity(
    rtPanelEntity: RtPanelEntityType,
    entityManager: EntityManager
)

Public functions

getCornerRadius

Added in 1.0.0-alpha01

fun getCornerRadius(): Float

Gets the corner radius of this PanelEntity in meters. Has a default value of 0.

getPixelDensity

Added in 1.0.0-alpha01

fun getPixelDensity(): Vector3

Gets the number of pixels per meter for this panel. This value reflects changes to scale, including parent scale.

Returns
`Vector3`	Vector3 scale applied to pixels within the Panel. (Z will be 0)

getPixelDimensions

Added in 1.0.0-alpha01

fun getPixelDimensions(): PixelDimensions

Returns the dimensions of the view underlying this PanelEntity.

Returns
`PixelDimensions`	The current (width, height) of the underlying surface in pixels.

getSize

open fun getSize(): Dimensions

Returns the spatial size of this Panel in meters. This includes any scaling applied to this panel by itself or its parents, which might be set via changes to setScale.

Returns
`Dimensions`	`Dimensions` size of this panel in meters. (Z will be 0)

setCornerRadius

Added in 1.0.0-alpha01

fun setCornerRadius(radius: Float): Unit

Sets the corner radius of the PanelEntity.

Parameters
`radius: Float`	The radius of the corners, in meters.

Throws
`kotlin.IllegalArgumentException`	if radius is <= 0.0f.

setPixelDimensions

Added in 1.0.0-alpha01

fun setPixelDimensions(pxDimensions: PixelDimensions): Unit

Sets the pixel (not Dp) dimensions of the view underlying this PanelEntity. Calling this might cause the layout of the Panel contents to change. Updating this will not cause the scale or pixel density to change.

Parameters
`pxDimensions: PixelDimensions`	The `PixelDimensions` of the underlying surface to set.