JxrPlatformAdapter.PanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

interface JxrPlatformAdapter.PanelEntity : JxrPlatformAdapter.Entity

Known direct subclasses

JxrPlatformAdapter.ActivityPanelEntity

JxrPlatformAdapter.ActivityPanelEntity

Interface for a SceneCore ActivityPanel entity.

Interface for a SceneCore Panel entity

Summary

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.
`JxrPlatformAdapter.PixelDimensions`	`getPixelDimensions()` Returns the dimensions of the view underlying this PanelEntity.
`JxrPlatformAdapter.Dimensions`	`getSize()` Returns the spatial size of this Panel in meters.
`Unit`	`setCornerRadius(value: Float)` Sets a corner radius on all four corners of this PanelEntity.
`Unit`	`setPixelDimensions(dimensions: JxrPlatformAdapter.PixelDimensions)` Sets the pixel (not Dp) dimensions of the view underlying this PanelEntity.

Inherited functions

From androidx.xr.scenecore.JxrPlatformAdapter.ActivityPose

`Pose`	`getActivitySpacePose()` Returns the pose for this entity, relative to the activity space root.
`Vector3`	`getActivitySpaceScale()` Returns the scale of this WorldPose relative to the activity space.
`Vector3`	`getWorldSpaceScale()` Returns the scale of this ActivityPose.
`Pose`	`transformPoseTo(pose: Pose, destination: JxrPlatformAdapter.ActivityPose)` Returns a pose relative to this entity transformed into a pose relative to the destination.

From androidx.xr.scenecore.JxrPlatformAdapter.Entity

`Unit`	`addChild(child: JxrPlatformAdapter.Entity)` Add given Entity as child.
`Unit`	`addChildren(children: (Mutable)List<JxrPlatformAdapter.Entity!>)`
`Boolean`	`addComponent(component: JxrPlatformAdapter.Component)` Add these components to entity.
`Unit`	`addInputEventListener( executor: Executor, listener: JxrPlatformAdapter.InputEventListener )` Adds the listener to the set of active input listeners, for input events targeted to this entity or its child entities.
`Unit`	`dispose()` Dispose any system resources held by this entity, and transitively calls dispose() on all the children.
`Float`	`getActivitySpaceAlpha()` Returns the total alpha transparency level for this Entity.
`Float`	`getAlpha()` Returns the set alpha transparency level for this Entity.
`(Mutable)List<JxrPlatformAdapter.Entity!>`	`getChildren()`
`JxrPlatformAdapter.Entity?`	`getParent()`
`Pose`	`getPose()` Returns the pose for this entity, relative to its parent.
`Vector3`	`getScale()` Returns the scale of this entity, relative to its parent.
`Boolean`	`isHidden(includeParents: Boolean)` Returns the hidden status of this Entity.
`Unit`	`removeAllComponents()` Remove all components from this entity.
`Unit`	`removeComponent(component: JxrPlatformAdapter.Component)` Remove the given component from the entity.
`Unit`	`removeInputEventListener( listener: JxrPlatformAdapter.InputEventListener )` Removes the given listener from the set of active input listeners.
`Unit`	`setAlpha(alpha: Float)` Sets the alpha transparency for the given Entity.
`Unit`	`setContentDescription(text: String)`
`Unit`	`setHidden(hidden: Boolean)` Sets the local hidden state of this Entity.
`Unit`	`setParent(parent: JxrPlatformAdapter.Entity?)`
`Unit`	`setPose(pose: Pose)` Updates the pose (position and rotation) of the Entity relative to its parent.
`Unit`	`setScale(scale: Vector3)` Sets the scale of this entity relative to its parent.
`Unit`	`setSize(dimensions: JxrPlatformAdapter.Dimensions)` Sets the size for the given Entity.

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(): JxrPlatformAdapter.PixelDimensions

Returns the dimensions of the view underlying this PanelEntity.

Returns
`JxrPlatformAdapter.PixelDimensions`	The current [PixelDimensions] of the underlying surface.

getSize

Added in 1.0.0-alpha01

fun getSize(): JxrPlatformAdapter.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
`JxrPlatformAdapter.Dimensions`	[Dimensions] size of this panel in meters. (Z will be 0)

setCornerRadius

Added in 1.0.0-alpha01

fun setCornerRadius(value: Float): Unit

Sets a corner radius on all four corners of this PanelEntity.

Parameters
`value: Float`	Corner radius in meters.

Throws
`java.lang.IllegalArgumentException`	if radius is <= 0.0f.

setPixelDimensions

Added in 1.0.0-alpha01

fun setPixelDimensions(dimensions: JxrPlatformAdapter.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
`dimensions: JxrPlatformAdapter.PixelDimensions`	The [PixelDimensions] of the underlying surface to set.