API reference
API reference
Select your platform
No SDKs available
No versions available

Panel

Panel

class Panel(panelRegistrationId: Int = 0, hittable: MeshCollision = MeshCollision.LineTest) : ComponentBase
The Panel component is used to spawn a panel attached to the associated entity. The PanelCreationSystem is responsible for creating and deleting the associated PanelSceneObjects for the entity. The panelRegistrationId attribute is used to find the associated PanelRegistration when creating a panel. See our Panel spawning docs for more information.
Usage:
```kotlin
override fun registerPanels(): List<PanelRegistration>(){
  return listOf(
    PanelRegistration(myPanelId) {
      entity -> // called for each entity you create
        config {
          ...
        }
    }
  )
}
...
// spawns two separate panels with the same registration
val my1stPanel = Entity.create(Panel(myPanelId))
val my2ndPanel = Entity.create(Panel(myPanelId))
```

Constructors

NameSummary
Panel
constructor(panelRegistrationId: Int = 0, hittable: MeshCollision = MeshCollision.LineTest)

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
open override var cachable: <Error class: unknown class>
entID
var entID: Long
hittable
var hittable: MeshCollision

hittable hit test type for the panel, @see MeshCollision. By default, collision is enabled.
isDirty
var isDirty: Boolean
panelRegistrationId
var panelRegistrationId: Int

panelRegistrationId The id of the panel. This is used to identify the @PanelRegistration when creating the panel.
recycled
var recycled: Boolean
timeStamp
var timeStamp: Long

Functions

NameSummary
companion
open override fun companion(): ComponentCompanion

Gets the companion object for this component.
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributePrimitive?

Gets the attribute type for the specified key.



fun getComponentDataAttributeType(keyString: String): AttributePrimitive?

Gets the attribute type for the specified string key.
getComponentDataKey
fun getComponentDataKey(key: String): Int?

Gets the integer key associated with the specified string key.
getComponentDataValue
fun getComponentDataValue(key: Int): Any?

Gets the value for the specified key.



fun getComponentDataValue(keyString: String): Any?

Gets the value for the specified string key.
getEnumClass
fun getEnumClass(key: String): Class<out Enum<*>>?

Gets the enum class associated with the specified string key.
hasComponentData
fun hasComponentData(key: Int): Boolean

Checks if this component has data for the specified key.



fun hasComponentData(keyString: String): Boolean

Checks if this component has data for the specified string key.
read
fun read(e: Entity, cachable: Boolean)

Reads component data from the specified entity.
recycle
fun recycle()

Recycles this component by returning it to its pool.
reset
open fun reset()

Resets the component to its default state.
setComponentDataValue
fun setComponentDataValue(key: Int, value: Any): Boolean

Sets the value for the specified key.



fun setComponentDataValue(keyString: String, value: Any): Boolean

Sets the value for the specified string key.
setPool
fun setPool(pool: ComponentPool<*>, entID: Long)

Sets the component pool and entity ID for this component.
toString
open override fun toString(): String
typeID
open override fun typeID(): Int

Returns the unique type ID of this component.
write
fun write(e: Entity)

Writes this component’s data to the specified entity.

Companion

object Companion : ComponentCompanion

Properties

NameSummary
attributeKeys_
val attributeKeys_: IntArray
attributeTypeCounts_
val attributeTypeCounts_: IntArray
attributeTypes_
val attributeTypes_: IntArray
attrMetaData_
val attrMetaData_: Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
createDefaultInstance
open override val createDefaultInstance: () -> Panel
enumClassesMap_
val enumClassesMap_: Map<Int, Class<out Enum<*>>>
hittableData
val hittableData: EnumAttributeData
hittableId
val hittableId: <Error class: unknown class>
id
open override val id: <Error class: unknown class>
keyStringToKeyIntMap_
val keyStringToKeyIntMap_: Map<String, Int>
panelRegistrationIdData
val panelRegistrationIdData: IntAttributeData
panelRegistrationIdId
val panelRegistrationIdId: <Error class: unknown class>

Functions

NameSummary
attributeKeys
open override fun attributeKeys(): IntArray
attributeMetaData
open override fun attributeMetaData(): Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
attributeTypeCountAvailable
open override fun attributeTypeCountAvailable(): Boolean
attributeTypeCounts
open override fun attributeTypeCounts(): IntArray
attributeTypes
open override fun attributeTypes(): IntArray
dependents
open fun dependents(): IntArray
enumClassesMap
open override fun enumClassesMap(): Map<Int, Class<out Enum<*>>>
keyStringToKeyIntMap
open override fun keyStringToKeyIntMap(keyString: String): Int?
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta