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

Box

Box

class Box(min: Vector3 = Vector3(0.0f, 0.0f, 0.0f), max: Vector3 = Vector3(0.0f, 0.0f, 0.0f)) : ComponentBase
Defines the dimensions of a box shape by the relative offset of two opposite corners. This is to be used with the mesh://box URI on Mesh component. Material can be customized with the Material component.
Example:
Entity.create(
        listOf(
            Mesh(Uri.parse("mesh://box")), // Applying box mesh
            Material().apply { // Applying Material Component for procdeurally generated mesh.
              baseColor = Color4(red = 1.0f, green = 0.1f, blue = 0.1f, alpha = 1.0f)
            },
            Box(Vector3(-0.25f, -0.25f, -0.25f), Vector3(0.25f, 0.25f, 0.25f)), // Modifying Box dimension with component
            Transform(Pose(Vector3(x = 0f, y = 0f, z = 0f))),
        ))

Constructors

NameSummary
Box
constructor(min: Vector3 = Vector3(0.0f, 0.0f, 0.0f), max: Vector3 = Vector3(0.0f, 0.0f, 0.0f))

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
open override var cachable: <Error class: unknown class>
entID
var entID: Long
isDirty
var isDirty: Boolean
max
var max: Vector3

The relative offset in meters of the top corner (furthest in the +x, +y, +z direction) of the box from the center
min
var min: Vector3

The relative offset in meters of the bottom corner (furthest in the -x, -y, -z direction) of the box from the center
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: () -> Box
enumClassesMap_
val enumClassesMap_: Map<Int, Class<out Enum<*>>>
id
open override val id: <Error class: unknown class>
keyStringToKeyIntMap_
val keyStringToKeyIntMap_: Map<String, Int>
maxData
val maxData: Vector3AttributeData
maxId
val maxId: <Error class: unknown class>
minData
val minData: Vector3AttributeData
minId
val minId: <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 override 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?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2025 Meta