API reference

PanelConfigOptions2 Interface

An ordered, immutable collection of PanelConfigOptions2Element that decorate or add behavior to Meta Spatial Panels.

Signature

interface PanelConfigOptions2

Methods

activity ()
Signature
fun PanelConfigOptions2.activity(): ActivityConfigOptions2?
activity ( activityClass )
Signature
fun PanelConfigOptions2.activity(activityClass: Class<*>): PanelConfigOptions2
Parameters
activityClass: Class
activity ( panelIntent )
Signature
fun PanelConfigOptions2.activity(panelIntent: Intent): PanelConfigOptions2
Parameters
panelIntent: Intent
all ( predicate )
Returns true if PanelConfigOptions2.all returns true for all PanelConfigOptions2Elements in this PanelConfigOptions2 or if this PanelConfigOptions2 contains no Elements.
Signature
open fun all(predicate: (PanelConfigOptions2Element<PanelConfigOptions2.Node>) -> Boolean): Boolean
Parameters
predicate: Function1
Returns
Boolean
any ( predicate )
Returns true if PanelConfigOptions2.any returns true for any PanelConfigOptions2Element in this PanelConfigOptions2.
Signature
open fun any(predicate: (PanelConfigOptions2Element<PanelConfigOptions2.Node>) -> Boolean): Boolean
Parameters
predicate: Function1
Returns
Boolean
composeView ( composeViewFun )
Parameters
composeViewFun: Function1
contentView ()
Signature
fun PanelConfigOptions2.contentView(): ContentViewConfigOptions2?
contentView ( layoutResourceId )
Signature
fun PanelConfigOptions2.contentView(layoutResourceId: Int): PanelConfigOptions2
Parameters
layoutResourceId: Int
contentView ( viewCreator )
Parameters
viewCreator: Function1
cylinder ()
Signature
fun PanelConfigOptions2.cylinder(): CylinderConfigOptions2?
cylinder ( options )
Signature
fun PanelConfigOptions2.cylinder(options: CylinderConfigOptions2): PanelConfigOptions2
Parameters
cylinder ( radius , height , width , pivotOffsetHeight , pivotOffsetWidth )
Signature
fun PanelConfigOptions2.cylinder(radius: Float? = null, height: Float? = null, width: Float? = null, pivotOffsetHeight: Float? = null, pivotOffsetWidth: Float? = null): PanelConfigOptions2
Parameters
radius: Float?
height: Float?
width: Float?
pivotOffsetHeight: Float?
pivotOffsetWidth: Float?
equirect ()
Signature
fun PanelConfigOptions2.equirect(): EquirectConfigOptions2?
equirect ( options )
Signature
fun PanelConfigOptions2.equirect(options: EquirectConfigOptions2): PanelConfigOptions2
Parameters
equirect ( radius , horizontalAngle , upperVerticalAngle , lowerVerticalAngle , pivotOffsetHeight , pivotOffsetWidth )
Signature
fun PanelConfigOptions2.equirect(radius: Float? = null, horizontalAngle: Float? = null, upperVerticalAngle: Float? = null, lowerVerticalAngle: Float? = null, pivotOffsetHeight: Float? = null, pivotOffsetWidth: Float? = null): PanelConfigOptions2
Parameters
radius: Float?
horizontalAngle: Float?
upperVerticalAngle: Float?
lowerVerticalAngle: Float?
pivotOffsetHeight: Float?
pivotOffsetWidth: Float?
geometry ()
Signature
fun PanelConfigOptions2.geometry(): GeometryConfigOptions2?
get ( type )
Gets the node of type PanelConfigOptions2.Node from the given PanelConfigOptions2.
Signature
open fun <R : PanelConfigOptions2.Node> get(type: Class<R>): R?
Parameters
type: Class
input ()
Signature
fun PanelConfigOptions2.input(): InputConfigOptions2?
input ( node )
Signature
fun PanelConfigOptions2.input(node: InputConfigOptions2): PanelConfigOptions2
Parameters
input ( clickButtons , grabButtons , scrollXLeftButtons , scrollXRightButtons , scrollYDownButtons , scrollYUpButtons , scrollXSpeed , scrollYSpeed )
Signature
fun PanelConfigOptions2.input(clickButtons: Int? = null, grabButtons: Int? = null, scrollXLeftButtons: Int? = null, scrollXRightButtons: Int? = null, scrollYDownButtons: Int? = null, scrollYUpButtons: Int? = null, scrollXSpeed: Float? = null, scrollYSpeed: Float? = null): PanelConfigOptions2
Parameters
clickButtons: Int?
grabButtons: Int?
scrollXLeftButtons: Int?
scrollXRightButtons: Int?
scrollYDownButtons: Int?
scrollYUpButtons: Int?
scrollXSpeed: Float?
scrollYSpeed: Float?
layer ( layerConfig )
Signature
fun PanelConfigOptions2.layer(layerConfig: LayerConfig?): PanelConfigOptions2
Parameters
layerConfig: LayerConfig?
layer ( alphaBlend , colorScaleBias , zIndex , secure , enabled )
Signature
fun PanelConfigOptions2.layer(alphaBlend: LayerAlphaBlend? = null, colorScaleBias: LayerColorScaleBias? = null, zIndex: Int? = null, secure: Boolean? = null, enabled: Boolean = true): PanelConfigOptions2
Parameters
alphaBlend: LayerAlphaBlend?
colorScaleBias: LayerColorScaleBias?
zIndex: Int?
secure: Boolean?
enabled: Boolean
layerConfig ()
Signature
fun PanelConfigOptions2.layerConfig(): LayerConfig?
material ()
Signature
fun PanelConfigOptions2.material(): MaterialConfigOptions2?
material ( node )
Signature
fun PanelConfigOptions2.material(node: MaterialConfigOptions2): PanelConfigOptions2
Parameters
material ( alphaMode , panelShader , unlit , stereoMode , overrideTexture , initializer )
Signature
fun PanelConfigOptions2.material(alphaMode: AlphaMode? = null, panelShader: String? = null, unlit: Boolean? = true, stereoMode: StereoMode? = null, overrideTexture: SceneTexture? = null, initializer: SceneMaterial.() -> Unit? = null): PanelConfigOptions2
Parameters
alphaMode: AlphaMode?
panelShader: String?
unlit: Boolean?
stereoMode: StereoMode?
overrideTexture: SceneTexture?
initializer: Function1?
meshCreator ()
Signature
fun PanelConfigOptions2.meshCreator(): PanelConfigOptions2.(texture: SceneTexture) -> SceneMesh
Returns
Function2
meshCreator ( sceneMeshCreator )
Signature
fun PanelConfigOptions2.meshCreator(sceneMeshCreator: PanelConfigOptions2.(texture: SceneTexture) -> SceneMesh? = null): PanelConfigOptions2
Parameters
sceneMeshCreator: Function2?
meshCreator ( meshCreator )
Signature
fun PanelConfigOptions2.meshCreator(meshCreator: MeshCreatorConfigOptions2): PanelConfigOptions2
Parameters
onPanelCreation ()
Signature
fun PanelConfigOptions2.onPanelCreation(): PanelSceneObject.(ent: Entity) -> Unit?
Returns
Function2?
onPanelCreation ( onPanelCreation )
Signature
fun PanelConfigOptions2.onPanelCreation(onPanelCreation: PanelSceneObject.(ent: Entity) -> Unit?): PanelConfigOptions2
Parameters
onPanelCreation: Function2?
quad ()
Signature
fun PanelConfigOptions2.quad(): QuadConfigOptions2?
quad ( options )
Signature
fun PanelConfigOptions2.quad(options: QuadConfigOptions2): PanelConfigOptions2
Parameters
quad ( height , width , pivotOffsetHeight , pivotOffsetWidth )
Signature
fun PanelConfigOptions2.quad(height: Float? = null, width: Float? = null, pivotOffsetHeight: Float? = null, pivotOffsetWidth: Float? = null): PanelConfigOptions2
Parameters
height: Float?
width: Float?
pivotOffsetHeight: Float?
pivotOffsetWidth: Float?
render ()
Signature
fun PanelConfigOptions2.render(): RenderConfigOptions2?
render ( node )
Signature
fun PanelConfigOptions2.render(node: RenderConfigOptions2): PanelConfigOptions2
Parameters
render ( mips , samplerConfig , forceSceneTexture , effectShader )
Signature
fun PanelConfigOptions2.render(mips: Int? = null, samplerConfig: SamplerConfig? = null, forceSceneTexture: Boolean? = null, effectShader: String? = null): PanelConfigOptions2
Parameters
mips: Int?
samplerConfig: SamplerConfig?
forceSceneTexture: Boolean?
effectShader: String?
resolution ()
Signature
fun PanelConfigOptions2.resolution(): ResolutionConfigOptions2?
resolution ( node )
Signature
fun PanelConfigOptions2.resolution(node: ResolutionConfigOptions2): PanelConfigOptions2
Parameters
resolution ( heightInPx , widthInPx , heightInDp , widthInDp , dpi , ratio , fractionOfScreen )
Signature
fun PanelConfigOptions2.resolution(heightInPx: Int? = null, widthInPx: Int? = null, heightInDp: Float? = null, widthInDp: Float? = null, dpi: Int? = null, ratio: Float? = null, fractionOfScreen: Float? = null): PanelConfigOptions2
Parameters
heightInPx: Int?
widthInPx: Int?
heightInDp: Float?
widthInDp: Float?
dpi: Int?
ratio: Float?
fractionOfScreen: Float?
style ()
Signature
fun PanelConfigOptions2.style(): StyleConfigOptions2?
style ( node )
Signature
fun PanelConfigOptions2.style(node: StyleConfigOptions2): PanelConfigOptions2
Parameters
style ( themeResourceId , enableTransparent , includeGlass )
Signature
fun PanelConfigOptions2.style(themeResourceId: Int? = null, enableTransparent: Boolean? = null, includeGlass: Boolean? = null): PanelConfigOptions2
Parameters
themeResourceId: Int?
enableTransparent: Boolean?
includeGlass: Boolean?
then ( other )
Concatenates this modifier with another.
Returns a PanelConfigOptions2 representing this modifier followed by PanelConfigOptions2.then in sequence.
Signature
open infix fun then(other: PanelConfigOptions2): PanelConfigOptions2
Parameters

Companion Object

Properties

TAG : String
[Get]
Signature
const val TAG: String

Methods

all ( predicate )
Returns true if PanelConfigOptions2.all returns true for all PanelConfigOptions2Elements in this PanelConfigOptions2 or if this PanelConfigOptions2 contains no Elements.
Signature
open fun all(predicate: (PanelConfigOptions2Element<PanelConfigOptions2.Node>) -> Boolean): Boolean
Parameters
predicate: Function1
Returns
Boolean
any ( predicate )
Returns true if PanelConfigOptions2.any returns true for any PanelConfigOptions2Element in this PanelConfigOptions2.
Signature
open fun any(predicate: (PanelConfigOptions2Element<PanelConfigOptions2.Node>) -> Boolean): Boolean
Parameters
predicate: Function1
Returns
Boolean
get ( type )
Gets the node of type PanelConfigOptions2.Node from the given PanelConfigOptions2.
Signature
open fun <R : PanelConfigOptions2.Node> get(type: Class<R>): R?
Parameters
type: Class
then ( other )
Signature
infix fun then(other: PanelConfigOptions2Element<PanelConfigOptions2.Node>): PanelConfigOptions2
then ( other )
Concatenates this modifier with another.
Returns a PanelConfigOptions2 representing this modifier followed by PanelConfigOptions2.then in sequence.
Signature
open infix fun then(other: PanelConfigOptions2): PanelConfigOptions2
Parameters
toString ()
Signature
open override fun toString(): String
Returns
String

Inner Class

Node Class

Modifiers: abstract
The longer-lived object that is created for each PanelConfigOptions2Element applied to a Meta Spatial Panel.

Signature

abstract class Node

Constructors

Node ()
Signature
constructor()
Returns
PanelConfigOptions2.Node