JxrPlatformAdapter.PanelEntity

Artifact: androidx.xr.scenecore:scenecore

Kotlin |Java

public interface JxrPlatformAdapter.PanelEntity extends JxrPlatformAdapter.Entity

Known direct subclasses

JxrPlatformAdapter.ActivityPanelEntity

JxrPlatformAdapter.ActivityPanelEntity

Interface for a SceneCore ActivityPanel entity.

Interface for a SceneCore Panel entity

Summary

Public methods
`abstract float`	`getCornerRadius()` Gets the corner radius of this PanelEntity in meters.
`abstract @NonNull Vector3`	`getPixelDensity()` Gets the number of pixels per meter for this panel.
`abstract @NonNull JxrPlatformAdapter.PixelDimensions`	`getPixelDimensions()` Returns the dimensions of the view underlying this PanelEntity.
`abstract @NonNull JxrPlatformAdapter.Dimensions`	`getSize()` Returns the spatial size of this Panel in meters.
`abstract void`	`setCornerRadius(float value)` Sets a corner radius on all four corners of this PanelEntity.
`abstract void`	`setPixelDimensions( @NonNull JxrPlatformAdapter.PixelDimensions dimensions )` Sets the pixel (not Dp) dimensions of the view underlying this PanelEntity.

Inherited methods

From androidx.xr.scenecore.JxrPlatformAdapter.ActivityPose

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

From androidx.xr.scenecore.JxrPlatformAdapter.Entity

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

Public methods

getCornerRadius

Added in 1.0.0-alpha01

abstract float getCornerRadius()

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

getPixelDensity

Added in 1.0.0-alpha01

abstract @NonNull Vector3 getPixelDensity()

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

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

getPixelDimensions

Added in 1.0.0-alpha01

abstract @NonNull JxrPlatformAdapter.PixelDimensions getPixelDimensions()

Returns the dimensions of the view underlying this PanelEntity.

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

getSize

Added in 1.0.0-alpha01

abstract @NonNull JxrPlatformAdapter.Dimensions getSize()

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

setCornerRadius

Added in 1.0.0-alpha01

abstract void setCornerRadius(float value)

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

Parameters
`float value`	Corner radius in meters.

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

setPixelDimensions

Added in 1.0.0-alpha01

abstract void setPixelDimensions(
    @NonNull JxrPlatformAdapter.PixelDimensions dimensions
)

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
`@NonNull JxrPlatformAdapter.PixelDimensions dimensions`	The [PixelDimensions] of the underlying surface to set.